Skip to content

Commit 79d97f0

Browse files
committed
docs: treat commits as documentation, single-commit PR titles must match commit title
1 parent b231ad8 commit 79d97f0

3 files changed

Lines changed: 10 additions & 4 deletions

File tree

AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
- Follow local package patterns; check `type-test.ts`, `__tests__/`, and plugin dirs before public API/platform changes.
1313
- Start with `okf-bundle/index.md` for repo-specific implementation/testing/maintenance knowledge.
1414
- Use package indexes under `okf-bundle/packages/` for package-specific workflows and active work queues.
15-
- Follow `okf-bundle/documentation-policy.md`: durable knowledge in reference docs; ephemeral state only in explicit work queues.
15+
- Follow `okf-bundle/documentation-policy.md`: durable knowledge in reference docs; ephemeral state only in explicit work queues; commits are documentation; single-commit PR titles must match the commit subject exactly.
1616
- Testing entry points: `okf-bundle/testing/index.md`; validation requirements: `okf-bundle/testing/validation-checklist.md`.
1717
- Match validation to the **work type** and **validation tier** in OKF ([iteration vocabulary](okf-bundle/testing/iteration-vocabulary.md), package workflows, active work queue gates).
1818

okf-bundle/documentation-policy.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,15 @@ Single source of truth for OKF knowledge and commit wording. Other OKF docs/work
2323
2. Ephemeral state lives **only** in work queues. When an item closes, durable outcomes move to reference docs; queue rows may archive/delete.
2424
3. Durable docs may link to a work queue for current status; do not duplicate ephemeral fields.
2525

26-
## Commits
26+
## Commits as documentation
2727

28-
Commit messages use Conventional Commits and describe durable product/process deliverables: what changed and why, not probe IDs, gates, e2e counts, or “phase X complete”.
28+
We treat **git commits** as durable documentation: they are the canonical record of what changed, when, and why — for humans and agents reviewing history later, not only for the current PR thread.
29+
30+
Commit messages use [Conventional Commits](https://www.conventionalcommits.org/) and describe durable product/process deliverables: what changed and why, not probe IDs, gates, e2e counts, or “phase X complete”.
31+
32+
## Pull requests
33+
34+
When a PR contains **exactly one commit**, the **PR title must match that commit's subject line exactly** (character-for-character). Multi-commit PRs use a summary title that describes the overall change set.
2935

3036
## OKF update contract
3137

okf-bundle/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ okf_version: "0.1"
44

55
# React Native Firebase knowledge bundle
66

7-
* [Documentation/commit policy](/documentation-policy.md) — durable vs ephemeral, commit wording, OKF consistency
7+
* [Documentation/commit policy](/documentation-policy.md) — durable vs ephemeral, commits as documentation, PR titles, OKF consistency
88

99
# CI workflows
1010

0 commit comments

Comments
 (0)