Skip to content

Commit

Permalink
docs: Update ref to No-Docs-Update-Reason
Browse files Browse the repository at this point in the history
Change-Id: I2e4ab5fc5dfc73316e1a2b8ae131a5427d02ff4a
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/256694
Pigweed-Auto-Submit: Ted Pudlik <[email protected]>
Lint: Lint 🤖 <[email protected]>
Commit-Queue: Auto-Submit <[email protected]>
Reviewed-by: Kayce Basques <[email protected]>
  • Loading branch information
tpudlik authored and CQ Bot Account committed Dec 27, 2024
1 parent 8e7fd5e commit 7cb8a82
Showing 1 changed file with 2 additions and 6 deletions.
8 changes: 2 additions & 6 deletions docs/contributing/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -189,12 +189,8 @@ Submission checklist
All Pigweed changes must either:

#. Include updates to documentation, or
#. Include ``No-Docs-Update-Reason: <reason>`` in a Gerrit comment on the CL.
For example:

* ``No-Docs-Update-Reason: formatting tweaks``
* ``No-Docs-Update-Reason: internal cleanups``
* ``No-Docs-Update-Reason: bugfix``
#. Assert no documentation is needed by voting +1 on the ``Docs-Not-Needed``
#label in Gerrit.

It's acceptable to only document new changes in an otherwise underdocumented
module, but it's not acceptable to not document new changes because the module
Expand Down

0 comments on commit 7cb8a82

Please sign in to comment.