From d22fa51ab8ced3cbee9dc133c3f0e1f5f31e12eb Mon Sep 17 00:00:00 2001 From: Randolph Sapp Date: Wed, 11 Dec 2024 23:55:12 -0600 Subject: [PATCH] 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 --- CONTRIBUTING.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bdc8f5d21..8d039bcdd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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