chore(docs): archive closed issue specs and add branch-name validation guidance#1901
Merged
josecelano merged 3 commits intoJun 10, 2026
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the repository’s workflow documentation by (1) archiving several issue specs that are already closed on GitHub (moving them from docs/issues/open/ to docs/issues/closed/ and marking them status: done) and (2) adding “branch-name validation” guidance across skills/agent docs plus a TODO note in the existing pre-commit hook script to prevent work being committed under the wrong (closed/non-existent) issue number.
Changes:
- Move 7 issue specs into
docs/issues/closed/and update frontmatter fields (status,spec-path,related-pr,last-updated-utc). - Add branch-name validation guidance to skills and the committer agent workflow.
- Add a TODO comment in
pre-commit.shto implement branch-name validation in the future Rust hooks runner (#1843), and extend the #1843 spec accordingly.
Reviewed changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
docs/issues/open/1843-migrate-git-hooks-scripts-from-bash-to-rust.md |
Adds semantic links and a Phase 2 task/AC for branch-name validation in the future Rust hooks runner. |
docs/issues/closed/1898-document-security-analysis-process.md |
Marks spec as closed/done and updates closed-spec frontmatter fields. |
docs/issues/closed/1894-1669-22-extract-torrust-located-error-to-standalone-repo.md |
Marks spec as closed/done and fills related-pr/timestamps. |
docs/issues/closed/1889-1669-21-migrate-from-bittorrent-primitives-to-torrust-info-hash.md |
Marks spec as closed/done and fills related-pr/timestamps. |
docs/issues/closed/1885-1669-20-extract-torrust-net-primitives-to-standalone-repo.md |
Updates related-pr/timestamps for the closed spec. |
docs/issues/closed/1884-1669-19-move-bittorrent-peer-id-to-torrust-bittorrent.md |
Marks spec as closed/done and normalizes related-pr to a PR number. |
docs/issues/closed/1882-1669-18-extract-torrust-metrics-to-standalone-repo.md |
Marks spec as closed/done and fills branch/PR metadata. |
docs/issues/closed/1869-1840-workflow-performance-dependency-layer-cache-reuse/ISSUE.md |
Marks the issue as done and updates the branch name to the concrete branch used. |
contrib/dev-tools/git/hooks/pre-commit.sh |
Adds a TODO note documenting desired future automation for branch-name validation. |
.github/skills/dev/git-workflow/run-pre-commit-checks/SKILL.md |
Adds a manual branch-name validation checklist item (until hooks automation exists). |
.github/skills/dev/git-workflow/create-feature-branch/SKILL.md |
Adds guidance/snippet to validate issue-number branches against docs/issues/open/. |
.github/agents/committer.agent.md |
Adds an explicit “validate branch name against open specs” step to the committer agent workflow. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #1901 +/- ##
========================================
Coverage 79.09% 79.10%
========================================
Files 326 326
Lines 22801 22801
Branches 22801 22801
========================================
+ Hits 18035 18036 +1
Misses 4510 4510
+ Partials 256 255 -1 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Move issue specs that have been closed on GitHub: - torrust#1869: dependency-layer cache reuse (PR torrust#1895) - torrust#1882: extract torrust-metrics to standalone repo (PR torrust#1892) - torrust#1884: move bittorrent-peer-id to torrust-bittorrent (PR torrust#1887) - torrust#1885: extract torrust-net-primitives to standalone repo (PR torrust#1893) - torrust#1889: migrate from bittorrent-primitives to torrust-info-hash (PR torrust#1891) - torrust#1894: extract torrust-located-error to standalone repo (PR torrust#1897) - torrust#1898: document security analysis process (PR torrust#1899) Update frontmatter headers: status -> done, spec-path -> closed/, add missing related-pr and branch fields, bump last-updated-utc.
…s, and hook script Update four files plus the git hooks migration spec to prevent committing under a wrong, closed, or non-existent issue number: - create-feature-branch/SKILL.md: validation step before branch creation - run-pre-commit-checks/SKILL.md: manual check for branch name validity - committer.agent.md: step 2 validates branch name against open specs - pre-commit.sh: TODO referencing torrust#1843 for future Rust automation - 1843-migrate-git-hooks-scripts-from-bash-to-rust.md: add T22 + AC22, cross-reference related artifacts
- Remove fragile bash snippet from create-feature-branch skill — the automation will be implemented in the Rust hooks runner (torrust#1843) - Make T22 wording consistent with AC22: blocking is mandatory, not optional
josecelano
force-pushed
the
chore/cleanup-completed-issue-specs
branch
from
3e5e097 to
c5f6add
Compare
Member
Author
|
ACK c5f6add |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Two independent changes on this branch:
1. Archive closed issue specs (commit 73263e9)
Move 7 issue specs from
docs/issues/open/todocs/issues/closed/that have been closed on GitHub, and update their frontmatter to reflect the closed state:torrust-metricsto standalone repobittorrent-peer-idtotorrust/torrust-bittorrenttorrust-net-primitivesto standalone repobittorrent-primitivestotorrust-info-hashtorrust-located-errorto standalone repo2. Branch-name validation guidance (commit 756284f)
Add validation guidance across the dev toolchain to prevent committing under a wrong, closed, or non-existent issue number:
create-feature-branch/SKILL.md— validation step before creating a branchrun-pre-commit-checks/SKILL.md— manual check for branch name validitycommitter.agent.md— step 2 validates branch name against open specspre-commit.sh— TODO referencing Migrate git hooks scripts from Bash to Rust #1843 for future Rust automation1843-migrate-git-hooks-scripts-from-bash-to-rust.md— added T22 + AC22, cross-reference related artifactsVerification
cargo machete— passlinter all— passcargo test --doc --workspace— pass