From fee5ff65cc51cc20823761f90f16a2dd770f027d Mon Sep 17 00:00:00 2001 From: Niru Maheswaranathan Date: Sun, 18 May 2025 10:27:13 -0700 Subject: [PATCH] Add project instructions --- AGENTS.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 AGENTS.md diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..602775d --- /dev/null +++ b/AGENTS.md @@ -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.