File tree Expand file tree Collapse file tree 1 file changed +16
-6
lines changed
Expand file tree Collapse file tree 1 file changed +16
-6
lines changed Original file line number Diff line number Diff line change @@ -11,12 +11,22 @@ not strictly enforced.
1111Please see the following for additional resources on commit formatting:
1212https://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+ Each commit has a tag with its type following the conventional commit
17+ convention. The 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 source
22+ - ` refactor ` : any modification that neither add a feature or fixes the source
23+ - ` build ` : changes that affect the build system, container, or external
24+ dependencies
25+ - ` ci ` : changes to the CI pipelines or associated scripts
26+ - ` docs ` : changes to * project* documentation, such as the main README
27+
28+ Other supported tags exist in the conventional commit specification, but they
29+ are not used as often here.
2030
2131## Project structure
2232
You can’t perform that action at this time.
0 commit comments