Skip to content

Commit 448ad39

Browse files
committed
docs(CONTRIBUTING): add examples for common tags
Add examples for the most common commit tags that are used in this repository. Signed-off-by: Randolph Sapp <[email protected]>
1 parent bb23839 commit 448ad39

File tree

1 file changed

+17
-6
lines changed

1 file changed

+17
-6
lines changed

CONTRIBUTING.md

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,23 @@ 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 docs tag for all changes is
16-
> not helpful. Please reserve usage of the docs tag for changes to this projects
17-
> documentation, such as the README or CONTRIBUTING documents. If the change is
18-
> adding information it should be treated as a feat, if it is changing incorrect
19-
> information it should be a fix.
14+
### Commit types
15+
16+
A has a tag with its type following the conventional commit convention. The
17+
following goes over the more common tags in this project.
18+
19+
- `feat`: any *addition* to the RST sources or platform configs
20+
- `fix`: any *correction* to the RST sources or platform configs
21+
- `style`: any modification that does not change the meaning of the of the
22+
source
23+
- `refactor`: any modification that neither add a feature or fixes the source
24+
- `build`: changes that affect the build system, container, or external
25+
dependencies
26+
- `ci`: changes to the CI pipelines or associated scripts
27+
- `docs`: changes to *project* documentation, such as the main README
28+
29+
Other supported tags exist in the conventional commit specification, but they
30+
are not used as often here.
2031

2132
## Project structure
2233

0 commit comments

Comments
 (0)