Skip to content

Commit 1e9c28a

Browse files
kv2019ilgirdwood
authored andcommitted
docs: AGENTS.md: align commit subject format with SOF conventions
Replace generic "feature: descriptive title" format with the actual SOF project convention "subsystem: component: short description" and add instruction to derive prefix from git log of modified files. Signed-off-by: Kai Vehmanen <kai.vehmanen@linux.intel.com>
1 parent 0000c4f commit 1e9c28a

1 file changed

Lines changed: 4 additions & 1 deletion

File tree

AGENTS.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,10 @@ This document outlines the rules AI agents must follow when checking out branche
55
## Development Standards
66

77
### Commitment and Sign-off Rules
8-
* **Commit Subject:** Must follow the format `feature: descriptive title`.
8+
* **Commit Subject:** Must follow the format `subsystem: component: short description` matching the SOF project convention. Use the git history of the modified file(s) (`git log --oneline -10 -- <file>`) to determine the correct subsystem and component prefix. Examples:
9+
* `audio: chain_dma: add user-space scheduling support`
10+
* `ipc4: handler: fix large config dispatch`
11+
* `schedule: zephyr_domain: add user-space LL thread`
912
* **Commit Body:** Should describe the changes in detail in the commit message body.
1013
* **Sign-off:** All commits must be signed off by the developer (`Signed-off-by: Name <email>`) using the identity from the local git config.
1114

0 commit comments

Comments
 (0)