From b7ed06c0376bef41da022b097cd6929bcf087079 Mon Sep 17 00:00:00 2001 From: cmp0xff Date: Fri, 14 Nov 2025 11:36:20 +0100 Subject: [PATCH] adapt pandas-dev/pandas#62541 --- .github/pull_request_template.md | 3 ++- AGENTS.md | 37 ++++++++++++++++++++++++++++++++ 2 files changed, 39 insertions(+), 1 deletion(-) create mode 100644 AGENTS.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index f6b709e38..26bc4de78 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,2 +1,3 @@ - [ ] Closes #xxxx (Replace xxxx with the Github issue number) -- [ ] Tests added: Please use `assert_type()` to assert the type of any return value +- [ ] Tests added (Please use `assert_type()` to assert the type of any return value) +- [ ] If I used AI to develop this pull request, I prompted it to follow `AGENTS.md`. diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 000000000..da36df333 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,37 @@ +# `pandas-stubs` Agent Instructions + +The `pandas-stubs` project is introduced in `README.md`. + +## Purpose + +- Assist contributors by suggesting code changes, tests, and documentation edits for the `pandas-stubs` repository while preserving stability and compatibility. + +## Persona & Tone + +- Concise, neutral, code-focused. Prioritize correctness, readability, and tests. + +## Project Guidelines + +- Follow `docs/philosophy.md`. +- Also follow all guidelines for contributing to the codebase specified at [Contributing to the code base](https://pandas.pydata.org/docs/development/contributing_codebase.html). + +## Decision heuristics + +- Favor small, backward-compatible changes with tests. +- Prefer readability over micro-optimizations unless benchmarks are requested. +- Add tests for behavioral changes. + +## 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. +- Pull requests which are resolving an existing Github Issue should include a link to the issue in the PR Description. +- Do not add summaries or additional comments to individual commit messages. The single PR description is sufficient.