Skip to content

Commit 9928aa5

Browse files
StaticRocketcshilwant
authored andcommitted
docs(contributing): add note about doc tag usage
Add a notice so contributors do not spam the docs tag unnecessarily for all changes. Signed-off-by: Randolph Sapp <[email protected]>
1 parent bd31564 commit 9928aa5

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,13 @@ not strictly enforced.
1111
Please see the following for additional resources on commit formatting:
1212
https://www.conventionalcommits.org/en/v1.0.0/
1313

14+
> [!NOTE]
15+
> This entire project is documentation. Using the docs tag for all changes is
16+
> not helpful. Please reserve usage of the docs tag for changes to this projects
17+
> documentation, such as the README or CONTRIBUTING documents. If the change is
18+
> adding information it should be treated as a feat, if it is changing incorrect
19+
> information it should be a fix.
20+
1421
## Project structure
1522

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

0 commit comments

Comments
 (0)