Skip to content

Commit

Permalink
doc(contributing): add note about doc tag usage
Browse files Browse the repository at this point in the history
Add a notice so contributors do not spam the doc tag unnecessarily for
all changes.

Signed-off-by: Randolph Sapp <[email protected]>
  • Loading branch information
StaticRocket committed Dec 12, 2024
1 parent bd31564 commit 4b2f083
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,11 @@ not strictly enforced.
Please see the following for additional resources on commit formatting:
https://www.conventionalcommits.org/en/v1.0.0/

> [!NOTE]
> This entire project is documentation. Using the doc tag for all changes is not
> helpful. Please reserve usage of the doc tag for changes to this projects
> documentation, such as the README or CONTRIBUTING documents.
## Project structure

This project uses reStructuredText (reST or RST) for generating standard HTML
Expand Down

0 comments on commit 4b2f083

Please sign in to comment.