From 9669a99dfcb40f88ee4744c54d78ba55b1a69419 Mon Sep 17 00:00:00 2001 From: Will Hawkins Date: Mon, 13 Apr 2026 05:03:55 -0400 Subject: [PATCH] Documentation: README: Describe commit message headline format Signed-off-by: Will Hawkins --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index 4af8347..3a15e9d 100644 --- a/README.md +++ b/README.md @@ -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: + +``` +: : +``` + +where `` 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 `` can be more free-form and `` is a pithy description of the changes in the commit. + #### Testing To run the P4RSE tests: