Просмотр исходного кода

AGENTS.md: sync with instructions of other repositories (#274)

Bring in rules established in the other repositories' AGENTS.md: only add information that isn't obvious from the repository, CHANGELOG wording for removed Python versions, keeping CI matrix / classifiers / python_requires consistent, and files synced with other repositories via `sync with` comments (`.github/dependabot.yml`, `.github/workflows/python.yml`).

Based on https://github.com/fphammerle/free-disk/blob/356731a084bb99e163f400833c198041664a154c/AGENTS.md and https://github.com/fphammerle/systemctl-mqtt/blob/985c7a418c277d45a1e51b07e489de423e1bffcc/AGENTS.md

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Fabian Peter Hammerle 2 недель назад
Родитель
Сommit
16bb82cb1a
1 измененных файлов с 16 добавлено и 1 удалено
  1. 16 1
      AGENTS.md

+ 16 - 1
AGENTS.md

@@ -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
 
@@ -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
 
@@ -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