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