Skip to content

Commit

Permalink
Update doc review section of maintainer guide
Browse files Browse the repository at this point in the history
bazelbuild#321 has been merged.
  • Loading branch information
tetromino committed May 16, 2022
1 parent 67bfa0c commit e9a3989
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions docs/maintainers_guide.md
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

0 comments on commit e9a3989

Please sign in to comment.