Skip to content

Commit e321c4f

Browse files
committed
Add instructions for Codex
1 parent d8a86f9 commit e321c4f

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

AGENTS.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Instructions for Codex
2+
3+
To run the test suite, execute:
4+
5+
```
6+
make test
7+
```
8+
9+
The tester executes a number of sample programs in `tests/programs` and compares their outputs to the fixtures in `tests/fixtures`.
10+
11+
# Code quality guidelines
12+
13+
- Strive to achieve high code quality.
14+
- Write secure code.
15+
- Make sure the code is well tested and edge cases are covered. Design the code for testability.
16+
- Write defensive code and make sure all potential errors are handled.
17+
- Strive to write highly reusable code with routines that have high fan in and low fan out.
18+
- Keep the code DRY.
19+
- Aim for low coupling and high cohesion. Encapsulate and hide implementation details.
20+
21+
# Code commenting guidelines
22+
23+
- Document public APIs and complex modules.
24+
- Maintain the comments together with the code to keep them meaningful and current.
25+
- Comment intention and rationale, not obvious facts. Write self-documenting code.
26+
- When implementing specific formats, standards or other specifications, make sure to
27+
link to the relevant spec URLs.
28+
29+
# Writing git commit messages
30+
31+
The first line of the commit message should follow the "conventional commits" style:
32+
https://www.conventionalcommits.org/en/v1.0.0/
33+
34+
In the remaining lines, provide a short description of the implemented functionality.
35+
Provide sufficient details for the justification of each design decision if multiple
36+
approaches were considered.

0 commit comments

Comments
 (0)