Skip to content

Add Codex instructions #545

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chrisaddy merged 1 commit into from
May 21, 2025
Merged

Add Codex instructions #545

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Codex Agent Instructions

This project uses **mise** tasks for code quality and tests. Run these steps before committing:

1. Install dependencies with `mise tasks run python:install`.
2. Format code with `mise run python:format`.
3. Run lint checks with `mise run python:lint`.
4. Execute tests with `mise run python:test`.
Comment thread
chrisaddy marked this conversation as resolved.

## Code Style
- Write tested, self-documenting code. Avoid comments unless the code is complex.

## Pull Requests
- Describe changes using `.github/PULL_REQUEST_TEMPLATE.md`.

## GitHub Issues
- When creating an issue, use the templates under `.github/ISSUE_TEMPLATE`.
- Include a clear title, the reason the feature or fix is needed, and two implementation options with cost-benefit analysis.

Loading