Skip to content

Commit 292e21d

Browse files
lrgirdwolgirdwood
authored andcommitted
agents: add an initial agents.md
Set out some high level rules for all agent code contributions. Signed-off-by: Liam Girdwood <liam.r.girdwood@linux.intel.com>
1 parent 07f53cb commit 292e21d

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Sound Open Firmware (SOF) Agent Workflows and Rules
2+
3+
This document outlines the rules AI agents must follow when checking out branches, writing code, documenting features, and running the development environment. Follow these rules carefully:
4+
5+
## Development Standards
6+
7+
### Commitment and Sign-off Rules
8+
* **Commit Subject:** Must follow the format `feature: descriptive title`.
9+
* **Commit Body:** Should describe the changes in detail in the commit message body.
10+
* **Sign-off:** All commits must be signed off by the developer (`Signed-off-by: Name <email>`) using the identity from the local git config.
11+
12+
### Documentation Requirements
13+
* **Doxygen Comments:** Any new C code or features must include Doxygen comments.
14+
* **Documentation Builds:** Integration of new code must not introduce any new Doxygen errors or warnings. Code additions should be verified against a clean documentation build.
15+
* **Architectural Consistency:** When adding or updating a file, any `architecture.md` or `README.md` in the same directory must be reviewed. The agent is responsible for ensuring documentation stays in sync with code logic changes.
16+
17+
### Codestyle and Linting
18+
* **Standard:** Use `clangd` instead of `checkpatch` for codestyle verification.
19+
* **Rationale:** `checkpatch` is prone to confusion with assembly and non-standard C; `clangd` provides better integration with IDEs and AI tools and is easier to maintain.

0 commit comments

Comments
 (0)