add scopes to commit message style

dylanljones · Dec 28, 2023 · 0fa6c78 · 0fa6c78
1 parent 31ee8a3
commit 0fa6c78
Showing 1 changed file with 13 additions and 1 deletion.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -22,7 +22,7 @@ $ pre-commit install
 A format influenced by [Angular commit message].
 
 ```text
-<type>: <subject>
+<type>(<scope>): <subject>
 <BLANK LINE>
 <body>
 <BLANK LINE>
@@ -44,6 +44,18 @@ Must be one of the following:
 - **update** Other configurations updates
 - **auto** Mostly used by automatic commits (for example from GitHub workflows)
 
+### Scope (optional)
+
+The scope should specify the affected part of the project.
+The following is a list of possible scopes:
+
+- **config**: Configuration handling
+- **xml**: Rekordbox XML database handling
+- **db**: Rekordbox v6 database handling
+- **anlz**: ANLZ file handling
+- **mysettings**: MySettings file handling
+
+
 ### Subject
 
 Use the summary field to provide a succinct description of the change: