Skip to content

AGENTS.md: sync with instructions of other repositories #243

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
fphammerle merged 1 commit into from
Oct 16, 2026
Merged

AGENTS.md: sync with instructions of other repositories #243

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
17 changes: 16 additions & 1 deletion AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@
record the lesson in `AGENTS.md` **automatically**, without being asked, so it isn't repeated.
- If a mistake recurs although a rule for it already exists, make that rule stricter and more
concrete (e.g. a mandatory check before acting) instead of just restating it.
- When writing or updating `AGENTS.md`, only add information that isn't already obvious from the
repository itself (e.g. Git LFS tracking is visible in `.gitattributes` and marked on GitHub).

## Commit messages

Expand All @@ -22,7 +24,8 @@

- Only document **user-facing** changes (features, bug fixes, removed support).
- Test tooling changes (e.g. `Pipfile`, `Pipfile.lock`) are not user-facing → no entry needed.
- Wording for Python version support: `declare compatibility with \`python3.X\``
- Wording for Python version support: `declare compatibility with \`python3.X\`` (under
`### Added`), `compatibility with \`python3.X\`` (under `### Removed`)

## Pull requests

Expand All @@ -40,6 +43,18 @@

- Fix CI failures automatically, iterating until all checks are green — no need to ask first.

## Supported Python versions

- Keep the `tests` matrix in `.github/workflows/python.yml`, the `Programming Language :: Python :: 3.X`
classifiers and `python_requires` in `setup.py` consistent when adding or dropping a Python version.
- The lowest supported Python version is the lowest one in that matrix.

## Files synced with other repositories

- Files starting with a `sync with <url>` comment are shared with other repositories. Keep them
structurally in sync and mention in the PR description when a change should be ported to the
referenced file as well.

## GitHub comments that @-mention a bot

- Commands like `@dependabot rebase` must reach GitHub as plain text — tool-call composition can
Expand Down