Skip to content

Commit 1f45211

Browse files
committed
docs: add DCO sign-off requirement to AGENTS.md
Signed-off-by: Sebastien Tardif <sebtardif@ncf.ca>
1 parent 713e121 commit 1f45211

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -202,6 +202,20 @@ someValue: "default"
202202
Using `# --` on every line causes helm-docs to treat each line as a
203203
separate parameter description, producing garbled output.
204204

205+
### Pull request titles and commit messages
206+
207+
The repository enforces semantic PR titles via [.github/workflows/pr-title.yaml](.github/workflows/pr-title.yaml) (the `amannn/action-semantic-pull-request` action).
208+
209+
- Allowed types: `feat`, `fix`, `docs`, `ci`, `refactor`, `test`, `chore`, `perf`, `build`, `revert`.
210+
- The subject (text after `type: `) **must start with a lowercase letter** (`subjectPattern: ^[a-z].+$`).
211+
- Good: `fix: e2e nightly RealisticLoad timeout + safe cache keys for secrets (no SHA256)`
212+
- Bad: `fix: E2E nightly ...` (capital E fails the regex and blocks the PR immediately).
213+
- The check runs on PR open/edit/synchronize and validates the PR title (and frequently the head commit message).
214+
- Dependabot PRs are automatically exempted by the workflow.
215+
- Always commit with `-s` (`git commit -s` or `git commit --amend -s`) so DCO passes. Never leave unexpanded shell like `$(git config user.name)` in the `Signed-off-by` line.
216+
217+
When creating branches, commits, or PRs, make the first line a valid semantic title so the gate passes on the first attempt. This avoids immediate CI failures and repeated title edits.
218+
205219
### MkDocs documentation links
206220

207221
MkDocs strict mode rejects relative links that resolve outside the `docs/`

0 commit comments

Comments
 (0)