docs(adr): adopt issue-number ADR ids + refresh numbering policy in README
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 82/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Quiet
- Domain
- documentation
Research direction
Start with docs/adr/README.md and compare its current numbering guidance with docs/ROADMAP_PROCESS.md. Update both documents to describe ADR--title.md, preserve existing D-0XX files as legacy, and document the ADR-to-issue-to-roadmap-to-PR flow; the work is done when the two files are consistent and the stated acceptance points are met.
Written by the indexing model from the issue text.
Description
Context
Sequential D-0XX ADR ids require a central allocator, but git branches are decentralized → collisions (the D-020 clash; see companion CI-guard issue). Decision taken on epic #204: derive ADR ids from the tracking GitHub issue number (ADR-<issue>). GitHub allocates issue numbers centrally, so ids are collision-free by construction — and the issue link is the thing we want anyway (ADR → issue → roadmap → PR per docs/ROADMAP_PROCESS.md).
Ask
- Update
docs/adr/README.md: it is stale and self-contradicting — says "D-005..D-020 are per-file" though files run to D-031, and "never reused" which was already violated. Document:- New ADRs:
docs/adr/ADR-<issue>-title.md(id = tracking issue number). - Existing
D-0XXfiles remain as legacy ids, not to be extended. - The ADR → issue → roadmap → PR flow.
- New ADRs:
- Optional ergonomics:
scripts/new-adr.sh "<title>" <issue#>scaffolder that stamps the header from the issue.
Acceptance
docs/adr/README.mdreflects current reality and the issue-number scheme.docs/ROADMAP_PROCESS.mdstays consistent with it.
Related
- First ADR on the new scheme:
ADR-204(epic #204). - Companion CI-guard issue (duplicate-ADR-id check).
Migrated from sp-prod-field/bnk-forge #418 (opened 2026-07-17; original labels: enhancement). That repository is archived and read-only.
Bare #NNN references in the text above refer to issues and PRs in the original repository, not to numbering here.
- Dominant language
- Python
- Stars
- 1
- Forks
- 1
- Avg merge
- 19h 7m
- Merged PRs (30d)
- 43
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from f5devcentral/bnk-forge
-
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
f5devcentral/bnk-forge#218 ·
-
Document dpus/hosts kubernetes_cluster_id overloading: deploy-registration vs BNK membership (S4) Openbare-metal documentation
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
f5devcentral/bnk-forge#117 ·
-
catalog enhancement frontend
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
f5devcentral/bnk-forge#88 ·
-
ci documentation enhancement verified
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
f5devcentral/bnk-forge#85 · 1 comment ·
-
bug documentation severity:low verified
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
f5devcentral/bnk-forge#84 · 1 comment ·
All issues in f5devcentral/bnk-forge
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100