Skip to content

Commit c282324

Browse files
Create AGENTS.md (#707)
Adding an AGENTS.md file for Codex use
1 parent 5fe096d commit c282324

File tree

1 file changed

+69
-0
lines changed

1 file changed

+69
-0
lines changed

AGENTS.md

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
Welcome to the OpenAI Agents SDK repository. This file contains the main points for new contributors.
2+
3+
## Repository overview
4+
5+
- **Source code**: `src/agents/` contains the implementation.
6+
- **Tests**: `tests/` with a short guide in `tests/README.md`.
7+
- **Examples**: under `examples/`.
8+
- **Documentation**: markdown pages live in `docs/` with `mkdocs.yml` controlling the site.
9+
- **Utilities**: developer commands are defined in the `Makefile`.
10+
- **PR template**: `.github/PULL_REQUEST_TEMPLATE/pull_request_template.md` describes the information every PR must include.
11+
12+
## Local workflow
13+
14+
1. Format, lint and type‑check your changes:
15+
16+
```bash
17+
make format
18+
make lint
19+
make mypy
20+
```
21+
22+
2. Run the tests:
23+
24+
```bash
25+
make tests
26+
```
27+
28+
To run a single test, use `uv run pytest -s -k <test_name>`.
29+
30+
3. Build the documentation (optional but recommended for docs changes):
31+
32+
```bash
33+
make build-docs
34+
```
35+
36+
Coverage can be generated with `make coverage`.
37+
38+
## Snapshot tests
39+
40+
Some tests rely on inline snapshots. See `tests/README.md` for details on updating them:
41+
42+
```bash
43+
make snapshots-fix # update existing snapshots
44+
make snapshots-create # create new snapshots
45+
```
46+
47+
Run `make tests` again after updating snapshots to ensure they pass.
48+
49+
## Style notes
50+
51+
- Write comments as full sentences and end them with a period.
52+
53+
## Pull request expectations
54+
55+
PRs should use the template located at `.github/PULL_REQUEST_TEMPLATE/pull_request_template.md`. Provide a summary, test plan and issue number if applicable, then check that:
56+
57+
- New tests are added when needed.
58+
- Documentation is updated.
59+
- `make lint` and `make format` have been run.
60+
- The full test suite passes.
61+
62+
Commit messages should be concise and written in the imperative mood. Small, focused commits are preferred.
63+
64+
## What reviewers look for
65+
66+
- Tests covering new behaviour.
67+
- Consistent style: code formatted with `ruff format`, imports sorted, and type hints passing `mypy`.
68+
- Clear documentation for any public API changes.
69+
- Clean history and a helpful PR description.

0 commit comments

Comments
 (0)