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