Skip to content

docs(CONTRIBUTING): add examples for common tags #460

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
StaticRocket merged 1 commit into from
Oct 4, 2025
Merged

docs(CONTRIBUTING): add examples for common tags #460

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
22 changes: 16 additions & 6 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,22 @@
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.
### Commit types

Each commit has a tag with its type following the conventional commit
convention. The following goes over the more common tags in this project.

- `feat`: any *addition* to the RST sources or platform configs

Check warning on line 19 in CONTRIBUTING.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Spelling] Verify the word 'configs'. It is not in the American English spelling dictionary used by Vale.

Raw Output:
{"message": "[RedHat.Spelling] Verify the word 'configs'. It is not in the American English spelling dictionary used by Vale.", "location": {"path": "CONTRIBUTING.md", "range": {"start": {"line": 19, "column": 58}}}, "severity": "WARNING"}

Check warning on line 19 in CONTRIBUTING.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Definitions] Define acronyms and abbreviations (such as 'RST') on first occurrence if they're likely to be unfamiliar.

Raw Output:
{"message": "[RedHat.Definitions] Define acronyms and abbreviations (such as 'RST') on first occurrence if they're likely to be unfamiliar.", "location": {"path": "CONTRIBUTING.md", "range": {"start": {"line": 19, "column": 34}}}, "severity": "INFO"}
- `fix`: any *correction* to the RST sources or platform configs

Check warning on line 20 in CONTRIBUTING.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Spelling] Verify the word 'configs'. It is not in the American English spelling dictionary used by Vale.

Raw Output:
{"message": "[RedHat.Spelling] Verify the word 'configs'. It is not in the American English spelling dictionary used by Vale.", "location": {"path": "CONTRIBUTING.md", "range": {"start": {"line": 20, "column": 59}}}, "severity": "WARNING"}

Check warning on line 20 in CONTRIBUTING.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Definitions] Define acronyms and abbreviations (such as 'RST') on first occurrence if they're likely to be unfamiliar.

Raw Output:
{"message": "[RedHat.Definitions] Define acronyms and abbreviations (such as 'RST') on first occurrence if they're likely to be unfamiliar.", "location": {"path": "CONTRIBUTING.md", "range": {"start": {"line": 20, "column": 35}}}, "severity": "INFO"}
- `style`: any modification that does not change the meaning of the source
- `refactor`: any modification that neither add a feature or fixes the source
- `build`: changes that affect the build system, container, or external
dependencies
- `ci`: changes to the CI pipelines or associated scripts
- `docs`: changes to *project* documentation, such as the main README

Other supported tags exist in the conventional commit specification, but they
are not used as often here.

## Project structure

Expand Down