docs(rules): add cross-referencing and sync mandates

Three new rules added to AGENTS.md and BASELINE-PROMPT.md:

1. Code/docs/tests must be kept in sync at all times — update all three
   in the same commit when making changes.
2. Redmine and Discourse must cross-reference each other — every ticket
   links to its Discourse doc and vice versa.
3. Commits must reference Redmine tickets ([#NNN]); PRs must link to
   both Redmine and Discourse.

💘 Generated with Crush

Assisted-by: Crush
This commit is contained in:
2026-08-10 09:18:31 -05:00
parent 0d76ca4ca5
commit 5aa6368ed4
2 changed files with 15 additions and 0 deletions
+3
View File
@@ -31,6 +31,8 @@
- **Discourse is the single system of record for documentation.** It is all Markdown. Use the `discourse-cli` tool. Do not author long-form docs in gitea.
- **Git-tracked `.md` files should be stubs** that point to the relevant Discourse URL. Short operational files that must live next to code (e.g. `AGENTS.md`, `STATUS.md`) are the exception.
- Engineering already works this way. Operations now does too.
- **Cross-referencing is mandatory.** Every Redmine ticket links to its Discourse doc; every Discourse doc links to its Redmine ticket(s); every commit references `[#NNN]`; every PR links to both Redmine and Discourse. Keep them in sync at all times.
- **Code, docs, and tests must be kept in sync at all times.** When you change code, update the corresponding docs (Discourse) and tests in the same commit. Never leave them out of sync.
## 4. Git workflow
@@ -38,6 +40,7 @@
- **Work smart off master** generally. Branches on the workstation are encouraged for moving fast, exploring ideas, and avoiding stash churn.
- **Once work leaves the workstation, it goes through a PR.**
- Branching strategy is open to per-project discussion.
- **Commits and PRs must cross-link** to Redmine tickets (`[#NNN]` in subject or body) and Discourse docs (in PR body).
## 5. CI/CD — shift left, keep in lockstep