Skip to content

Add AGENTS instructions #16

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
nirum merged 1 commit into from
May 18, 2025
Merged

Add AGENTS instructions #16

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
13 changes: 13 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Developer Instructions

## Code Style
- Run `ruff check .` before committing to ensure all Python code passes linting.
- Write clear docstrings for all public functions and classes.
- Use relative imports within the `jetplot` package.

## Testing
- Execute `pytest` and ensure all tests pass before submitting a PR.

## PR Guidelines
- Your pull request description must contain a **Summary** section explaining the changes.
- Include a **Testing** section describing the commands used to run lint and tests along with their results.