Skip to content

Commit 4b2f083

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

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,11 @@ 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 doc tag for all changes is not
16+
> helpful. Please reserve usage of the doc tag for changes to this projects
17+
> documentation, such as the README or CONTRIBUTING documents.
18+
1419
## Project structure
1520

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

0 commit comments

Comments
 (0)