Skip to content
Prev Previous commit
Next Next commit
add PR section
  • Loading branch information
Justine Wezenaar committed Oct 15, 2025
commit 4104ea8157faea79638f15929b28dfe8e814363d
13 changes: 13 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,16 @@
- Follow NumPy / numpydoc conventions used across the repo: short summary, extended summary, Parameters, Returns/Yields, See Also, Notes, Examples.
- Ensure examples are deterministic, import numpy/pandas as documented, and pass doctest rules used by docs validation.
- Preserve formatting rules: triple double-quotes, no blank line before/after docstring, parameter formatting ("name : type, default ..."), types and examples conventions.

## Pull Requests (summary)
- Pull request titles should be descriptive and include one of the following prefixes:
- ENH: Enhancement, new functionality
- BUG: Bug fix
- DOC: Additions/updates to documentation
- TST: Additions/updates to tests
- BLD: Updates to the build process/scripts
- PERF: Performance improvement
- TYP: Type annotations
- CLN: Code cleanup
- Pull request descriptions should follow the template, and **succinctly** describe the change being made. Usually a few sentences is sufficient.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we add "Only add or update summaries in the opening post. Do not add summaries in other comments."

In the past, each update with an AI-assisted PR comes with a comment summarizing what was done in the commit. This is unnecessary, adds noise, and has the risk of being inaccurate; the commit is sufficient for determining what was done.

- Pull requests which are resolving an existing Github Issue should include a link to the issue in the PR Description.
Loading