Skip to content

Commit 53e9094

Browse files
authored
Merge pull request #1939 from giuseppe/add-AGENTS.md
AGENTS.md: new file
2 parents e0a6f43 + 88f5512 commit 53e9094

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

AGENTS.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# AGENTS.md
2+
3+
## Code Style
4+
5+
- Always preserve existing indentation style in each file, and validate it with
6+
`make clang-format`.
7+
- Do not add inline comments explaining the change they belong to.
8+
9+
## Git Commit Rules
10+
11+
- Each logical change must be in its own separate commit.
12+
- Fixes for existing commits in the current branch must use fixup commits:
13+
```bash
14+
git commit --fixup=<original-commit-hash>
15+
```
16+
17+
## Commit Authorship
18+
19+
- Keep the original author (do not change git config)
20+
- Add agent signature at the end of commit messages.
21+
22+
## Adding New Files
23+
24+
- New source or test files must be added to `Makefile.am`
25+
- After adding files, verify the build with `make distcheck`
26+
27+
## Adding New Tests
28+
29+
- Python tests go in `tests/test_*.py`, register in `all_tests` dict, and add to `PYTHON_TESTS` in root `Makefile.am`
30+
- C unit tests go in `tests/tests_libcrun_*.c`, add to `UNIT_TESTS` in root `Makefile.am` with build rules
31+
- Test functions should return `0` (pass), `-1` (fail), or `77` (skip)

0 commit comments

Comments
 (0)