Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update doc review section of maintainer guide #368

Merged
merged 2 commits into from
May 17, 2022
Merged

Update doc review section of maintainer guide #368

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e9a3989
Update doc review section of maintainer guide
tetromino May 16, 2022
1229fef
Merge branch 'main' into doc
tetromino May 17, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions docs/maintainers_guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,13 @@ widespread pain, and shouldn't be done lightly. Therefore:

In addition, make sure that new code is documented and tested.

If a PR adds or changes any docstrings, check that Markdown docs in `docs`
directory are updated; if not, ask the PR author to run
`./docs/regenerate_docs.sh`. (See
https://github.com/bazelbuild/bazel-skylib/pull/321 for the proposal to automate
this.)
If a PR changes any docstring in an existing module, the corresponding
`stardoc_with_diff_test` in `docs` will fail. To fix the test, ask the PR
author to run `bazel run //docs:update`.

If a PR adds a new module, make sure that the PR also adds a corresponding
`stardoc_with_diff_test` target in `docs/BUILD` and a corresponding `*doc.md`
file under `docs` (generated by `bazel run //docs:update`).

## Making a New Release

Expand Down