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

AGENTS.md: list only package changes relevant to how the project uses the package

The description of the tor 0.4.9.17 update (fphammerle/docker-onion-service#180) initially listed relay DoS defenses, relay handshake checks, exit DNS resolution and HTTPTunnelPort stream isolation, none of which apply to an image running only an onion service with `SocksPort 0`. The previous example ("relay / client behaviour changes") encouraged this. The rule is worded without project-specific details so it can be shared with the other repositories' `AGENTS.md`.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude 11 часов назад
Родитель
Сommit
65ccfdef3a
1 измененных файлов с 7 добавлено и 1 удалено
  1. 7 1
      AGENTS.md

+ 7 - 1
AGENTS.md

@@ -23,7 +23,13 @@
 - Package version updates (e.g. `TOR_PACKAGE_VERSION` in `Dockerfile`): keep the subject line
   `update <package> from <old> to <new>` and list the **relevant changes** of the new version in
   the body, taken from the upstream changelog linked in the comments above the version `ARG`
-  (e.g. security fixes, onion service / relay / client behaviour changes).
+  (e.g. security fixes or behaviour changes affecting features in use).
+  - "Relevant" means relevant to **how this project uses the package**: before listing a change,
+    check it against the project's actual configuration and usage (e.g. config files and
+    templates, `Dockerfile`, entrypoint, code calling the package) and leave out changes that only
+    affect features, roles, modes or options the project doesn't use — even security fixes with a
+    CVE / advisory id. Keep changes to what it does use, including defaults and infrastructure it
+    relies on implicitly (e.g. built-in server lists, certificates, protocol requirements).
 - Never justify a package version update with the old pinned version no longer being installable
   or the build failing because of it (e.g. "so the pinned version can no longer be installed") —
   pins are intentional and breaking when the distribution moves on is their whole point. Keep the