Skip to content

Commit a3ad3c8

Browse files
cliffhallclaude
andcommitted
docs: exempt comment-less formats from purpose headers; widen the Dependabot exception
Co-Authored-By: Claude Opus 5.5 <[email protected]> Signed-off-by: cliffhall <[email protected]>
1 parent 6c88e66 commit a3ad3c8

1 file changed

Lines changed: 8 additions & 4 deletions

File tree

‎AGENTS.md‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -59,14 +59,16 @@ applies repo-wide goes in this file, never only in a nested one.**
5959
### New and rewritten source files open with a purpose header
6060

6161
A source file you create, or substantially rewrite (code, tests, scripts,
62-
workflows, configuration), opens with a comment stating what the file is for
62+
workflows, configuration in a format that has comments), opens with a comment
63+
stating what the file is for
6364
and the reasoning behind it: the first comment in the file,
6465
**after any shebang**. `#!/usr/bin/env node` must stay on line 1 of an
6566
executable entry point, or the published bin stops working. This is not a bulk
6667
migration: files you only touch in passing keep their current form. Read that
6768
header rather than restating its reasoning in this file, since a duplicated
6869
rationale goes stale silently. A Markdown document states its purpose in its
69-
opening paragraph instead, as this one does.
70+
opening paragraph instead, as this one does. A format with no comment syntax
71+
(JSON, such as `package.json`) is exempt.
7072

7173
## Development setup
7274

@@ -156,8 +158,10 @@ PR flow, this rule governs.
156158
work is invisible to the board. If there is no issue yet, create it first. This
157159
holds for a maintainer's own one-line fix as much as for a feature.
158160

159-
- **Temporary exception: Dependabot PRs.** Dependabot still opens issue-less PRs
160-
(weekly GitHub Actions bumps, and security-fix PRs). They are exempt until the
161+
- **Temporary exception: Dependabot PRs.** Dependabot still opens its own PRs
162+
(weekly GitHub Actions bumps, and security-fix PRs), against `main`, with no
163+
linked issue, no `v2` label and no checklist. They are exempt from the PR rules
164+
in this file (issue link, base branch, labels, checklist, board) until the
161165
change that replaces them with issue-filing sweeps lands and removes this
162166
exception. No other PR is exempt.
163167

0 commit comments

Comments
 (0)