• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1We welcome your contributions! To contribute to Stardoc, fork the
2[Stardoc](https://github.com/bazelbuild/stardoc) GitHub repository and start
3submitting pull requests.
4
5In general, we prefer contributions that fix bugs or add features (as opposed to
6purely stylistic, refactoring, or "cleanup" changes). Please check with us by
7opening a [GitHub Issue](https://github.com/bazelbuild/stardoc/issues) or emailing the
8[bazel-dev](https://groups.google.com/forum/#!forum/bazel-dev) mailing list.
9
10## Stardoc code structure
11
12* The [bazelbuild/stardoc](https://github.com/bazelbuild/stardoc) repository
13  contains Stardoc's Starlark code alongside Stardoc's prebuilt java binaries (jars).
14* The source code for Stardoc's jars can be found under the bazelbuild/bazel source tree
15  [here](https://github.com/bazelbuild/bazel/tree/master/src/main/java/com/google/devtools/build/skydoc).
16  Changes to Stardoc's java binaries will thus require creation of pull requests to the
17  [bazelbuild/bazel](https://github.com/bazelbuild/bazel) repository.
18* Changes to Stardoc's source are pulled in by updating bazelbuild/stardoc's dependency
19  on the bazel source tree and and then rebuilding the binary using bazel. This process
20  is done periodically by Stardoc's [core contributors](#core-contributors) (generally
21  with large changes to Stardoc source, and right before cutting a new Stardoc release).
22
23## Contributing to Stardoc
24
25* Stardoc is part of the Bazel project. Read the [Bazel governance
26  plan](https://www.bazel.build/governance.html) and Stardoc's [contribution
27  guidelines](../CONTRIBUTING.md).
28* Open an [Issue](https://github.com/bazelbuild/stardoc/issues) or discuss your
29  plan or design on the [bazel-dev](https://groups.google.com/forum/#!forum/bazel-dev)
30  mailing list.
31* Prepare a Git commit that implements your feature or bug fix. Don't forget to
32  add tests and reference the corresponding bug, if any.
33* Open a [Pull Request](https://github.com/bazelbuild/stardoc/pulls) on the Stardoc
34  repository. This will require that you have signed a
35  [Contributor License Agreement](https://cla.developers.google.com/).
36* Complete a code review with a [core contributor](#core-contributors). Amend your
37  patch by making additional commits or rebasing with HEAD if there are conflicts with new
38  commits on the master branch.
39* Once the code review is complete, your reviewer will squash/merge your pull
40  request to the master branch.
41
42## Core Contributors
43
44The current group of Stardoc core contributors are:
45
46* [brandjon](https://github.com/brandjon)
47* [cparsons](https://github.com/c-parsons)
48* [jin](https://github.com/jin)
49* [laurentlb](https://github.com/laurentlb)
50
51
52
53