Skip to content

Commit

Permalink
docs(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 docs tag unnecessarily for
all changes.

Signed-off-by: Randolph Sapp <[email protected]>
  • Loading branch information
@StaticRocket @cshilwant
StaticRocket authored and cshilwant committed Dec 12, 2024
1 parent bd31564 commit 9928aa5
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,13 @@ 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 docs tag for all changes is
> not helpful. Please reserve usage of the docs tag for changes to this projects
> documentation, such as the README or CONTRIBUTING documents. If the change is
> adding information it should be treated as a feat, if it is changing incorrect
> information it should be a fix.
## Project structure

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

0 comments on commit 9928aa5

Please sign in to comment.