hawkinsw/gp4
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Documentation: README: Describe commit message headline format

Browse Source 
Signed-off-by: Will Hawkins <hawkinsw@obs.cr>
This commit is contained in:
Will Hawkins
2026-04-13 05:03:55 -04:00
parent fcb3b4e304
commit 9669a99dfc
1 changed files with 19 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+19
View File
@@ -68,6 +68,25 @@ Here are the style guidelines that we are _trying_ to maintain:
Of course, we want to follow the formatter, too: see [below](#checking-format).
#### Commit Messages
We will try to maintain the following headline format for commit messages:
```
<component>: <subcomponent>: <change>
```
where `<component>` is one of:
1. `grammar`: For the tree-sitter-based grammar.
2. `compiler`: For the Swift-based P4 compiler of tree-sitter-based-parser parsed programs into AST.
3. `runtime`: For the Swift-based P4 interpreter.
4. `common`: For any Swift-based components common to the entire project (and macros).
5. `documentation`: For any documentation updates.
6. `testing`: For Swift-based tests.
where `<subcomponent>` can be more free-form and `<change>` is a pithy description of the changes in the commit.
#### Testing
To run the P4RSE tests: