Skip to content

Commit b7ed06c

Browse files
committed
1 parent 10bddcd commit b7ed06c

File tree

2 files changed

+39
-1
lines changed

2 files changed

+39
-1
lines changed

.github/pull_request_template.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
- [ ] Closes #xxxx (Replace xxxx with the Github issue number)
2-
- [ ] Tests added: Please use `assert_type()` to assert the type of any return value
2+
- [ ] Tests added (Please use `assert_type()` to assert the type of any return value)
3+
- [ ] If I used AI to develop this pull request, I prompted it to follow `AGENTS.md`.

AGENTS.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# `pandas-stubs` Agent Instructions
2+
3+
The `pandas-stubs` project is introduced in `README.md`.
4+
5+
## Purpose
6+
7+
- Assist contributors by suggesting code changes, tests, and documentation edits for the `pandas-stubs` repository while preserving stability and compatibility.
8+
9+
## Persona & Tone
10+
11+
- Concise, neutral, code-focused. Prioritize correctness, readability, and tests.
12+
13+
## Project Guidelines
14+
15+
- Follow `docs/philosophy.md`.
16+
- 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).
17+
18+
## Decision heuristics
19+
20+
- Favor small, backward-compatible changes with tests.
21+
- Prefer readability over micro-optimizations unless benchmarks are requested.
22+
- Add tests for behavioral changes.
23+
24+
## Pull Requests (summary)
25+
26+
- Pull request titles should be descriptive and include one of the following prefixes:
27+
- ENH: Enhancement, new functionality
28+
- BUG: Bug fix
29+
- DOC: Additions/updates to documentation
30+
- TST: Additions/updates to tests
31+
- BLD: Updates to the build process/scripts
32+
- PERF: Performance improvement
33+
- TYP: Type annotations
34+
- CLN: Code cleanup
35+
- Pull request descriptions should follow the template, and **succinctly** describe the change being made. Usually a few sentences is sufficient.
36+
- Pull requests which are resolving an existing Github Issue should include a link to the issue in the PR Description.
37+
- Do not add summaries or additional comments to individual commit messages. The single PR description is sufficient.

0 commit comments

Comments
 (0)