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