Skip to content

docs(contributing): add note about doc tag usage #106

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cshilwant merged 1 commit into from
Dec 12, 2024
Merged

docs(contributing): add note about doc tag usage #106

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
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
Loading