Skip to content

Latest commit

 

History

History
52 lines (43 loc) · 2.71 KB

contributing.md

File metadata and controls

52 lines (43 loc) · 2.71 KB
Raw

Before contributing, please see the note on our current priorities. In short, we're able to take bugfixes to critical features, but cannot guarantee that we'll be able to review new features in a timely manner.

To contribute to Stardoc, first see the official contributing notice, then feel free to fork the Stardoc GitHub repository and start submitting pull requests.

In general, we prefer contributions that fix bugs or add features (as opposed to purely stylistic, refactoring, or "cleanup" changes). Please check with us by opening a GitHub Issue or starting a GitHub Discussion.

Stardoc code structure

  • Stardoc internally relies on Bazel's starlark_doc_extract rule to extract documentation in proto format (vendored into Stardoc's repo in stardoc/proto/stardoc_output.proto)
  • The src directory contains Stardoc's renderer, written in Java, which transforms the proto output into Markdown.
  • The stardoc directory contains the Starlark rule and wrapper macro which serves as the entry point for Stardoc users, and the default Velocity templates which configure Markdown output.
  • Java unit tests live in the src/test directory, while integration tests are in the test directory.

Contributing to Stardoc

  • Stardoc is part of the Bazel project. Read the Bazel governance plan and Stardoc's contribution guidelines.
  • Open an Issue or discuss your plan or design on Github Discussions
  • Prepare a Git commit that implements your feature or bug fix. Don't forget to add tests and reference the corresponding bug, if any.
  • Open a Pull Request on the Stardoc repository. This will require that you have signed a Contributor License Agreement.
  • Complete a code review with a core contributor. Amend your patch by making additional commits or rebasing with HEAD if there are conflicts with new commits on the master branch.
  • Once the code review is complete, your reviewer will squash/merge your pull request to the master branch.

Core Contributors

The current group of Stardoc core contributors are: