Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .claude/rules/pr-body-contract.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# PR body contract

The `pr-contract` step inside `CI Status` fails a pull request on a
The `check-contract` step inside `CI Status` fails a pull request on a
non-Conventional-Commits title or a `do-not-merge` label, and, in repositories
that enable it, on a body line that would start with the word `committer` after
the 72-column squash wrap, which breaks the squash commit's signature: reword
Expand Down
4 changes: 2 additions & 2 deletions docs/standards/issue-tracker.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Labels follow one grammar across every axis, so a reader parses any label withou

The naming grammar above governs labels only. Issue titles are free text: there is no enforced prefix vocabulary, and titles do not carry a conventional-commit-style tag such as `[CC]` or `feat(scope):`. This is a deliberate choice, not a gap: GitHub's categorization mechanism is structured metadata (org Issue Types, labels, milestones), not title encoding. The type axis lives in native Issue Types (`Bug`, `Feature`, `Task`); the area axis lives in labels or the parent issue. A title prefix would duplicate an axis that already exists elsewhere and drift out of sync with it. Write a plain summary that describes the issue, starting with a verb where the issue is work to do ("Retry the token mint on a 502"), with no `X:` or `[X]` prefix.

**Structured metadata, not title prefixes.** Set the type with `--type` or the issue form's Types field; set area and other axes with labels. PR titles are unchanged, remaining Conventional Commits enforced by the `pr-contract` composite inside the required `CI Status` check, because squash-merge makes the PR title the default-branch subject line. Issue titles and PR titles serve different layers and follow different rules.
**Structured metadata, not title prefixes.** Set the type with `--type` or the issue form's Types field; set area and other axes with labels. PR titles are unchanged, remaining Conventional Commits enforced by the `check-contract` composite inside the required `CI Status` check, because squash-merge makes the PR title the default-branch subject line. Issue titles and PR titles serve different layers and follow different rules.

**Issue forms set no title prefix.** GitHub's issue-form examples ship a `title: "[Bug]: "` default; forms here leave `title` empty and set the type through the form's `type:` key instead, so every issue reads the same. The one exception is the agent-ready work-item form, which sets no type: its work can be a bug, a feature or a task, so triage sets the type (the [issue-body contract](https://github.com/melodic-software/standards/blob/main/components/issue-body-contract/README.md#rules-the-contract-keeps) records why).

Expand Down Expand Up @@ -98,7 +98,7 @@ Reconcile recurring items by a dedicated bare marker label (for example `recurri

## Closing pull requests

A pull request that resolves an issue uses one of GitHub's native closing keywords as the default house style. The keyword is what wires the automatic link and auto-close on merge; a plain-text reference like "see #123" does neither, and a disclaimer around a keyword does not stop it, because GitHub's parser ignores the surrounding words. The pull-request body contract is not restated here: the `body` fields of `components/pr-convention-policy/policy.json` record it (the accepted linkage lines, including how to link without closing and the no-issue opt-out, and the required sections), and the `ci-workflows` `pr-contract` composite enforces it. The practice applies org- and account-wide, not only where a CI gate can check it. This began as `provisioning`'s stricter convention (decisions log #58/#59); the shared `pr-contract` composite inside each requires-ci repository's `CI Status` check reports it, leaving an advisory comment and the `needs-issue-linkage` label rather than failing the check, and repositories without CI follow the same convention unreported.
A pull request that resolves an issue uses one of GitHub's native closing keywords as the default house style. The keyword is what wires the automatic link and auto-close on merge; a plain-text reference like "see #123" does neither, and a disclaimer around a keyword does not stop it, because GitHub's parser ignores the surrounding words. The pull-request body contract is not restated here: the `body` fields of `components/pr-convention-policy/policy.json` record it (the accepted linkage lines, including how to link without closing and the no-issue opt-out, and the required sections), and the `ci-workflows` `check-contract` composite enforces it. The practice applies org- and account-wide, not only where a CI gate can check it. This began as `provisioning`'s stricter convention (decisions log #58/#59); the shared `check-contract` composite inside each requires-ci repository's `CI Status` check reports it, leaving an advisory comment and the `needs-issue-linkage` label rather than failing the check, and repositories without CI follow the same convention unreported.

## Optional conventions

Expand Down
Loading