bazel
/
bazel-skylib
mirror of https://github.com/bazelbuild/bazel-skylib
2
0
Fork 0
Code Issues Releases Activity

Update doc review section of maintainer guide (#368) 

https://github.com/bazelbuild/bazel-skylib/pull/321 has been merged.
This commit is contained in:
Alexandre Rostovtsev 2022-05-17 07:31:01 -04:00 committed by GitHub
parent a6f17ab1fe
commit 312bccd83b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/maintainers_guide.md
View File

@ -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