Skip to content

docs(pr-reviews): [#2233] tune review process guidance - #2237

Merged
josecelano merged 10 commits into
torrust:developfrom
josecelano:2233-2003-tune-unified-pr-review-process
Sep 16, 2026
Merged

josecelano merged 10 commits into
torrust:developfrom
josecelano:2233-2003-tune-unified-pr-review-process

Conversation

@josecelano

Copy link
Copy Markdown
Member

This PR tunes the unified PR-review process from the first-use evidence gathered in #2219/#2232.

Closes #2233.

Summary

  • Aligns reviewer-facing PR review guidance and the advisory finding template with the unified author-side review workflow.
  • Records code-span path evidence and defers strict path-reference enforcement to a broader semantic-link/frontmatter conventions EPIC.
  • Adds migration safeguards to process-pr-review for retiring workflow documents and verifying rename purity.
  • Adds a design-only tiered model routing note without implementing automation.
  • Records manual verification, implementation retrospective, and independent task-review evidence.

Validation

  • linter markdown
  • linter cspell
  • linter lychee
  • git diff --check
  • bash contrib/dev-tools/checks/tests/test-agent-review-report-contract.sh
  • TORRUST_GIT_HOOKS_LOG_DIR=.tmp ./contrib/dev-tools/git/hooks/pre-commit.sh --format=text

@josecelano
josecelano requested a review from a team as a code owner September 16, 2026 15:10
Copilot AI lite review requested due to automatic review settings September 16, 2026 15:10
@josecelano josecelano self-assigned this Sep 16, 2026
@codecov

codecov Bot commented Sep 16, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 85.39%. Comparing base (23a68e0) to head (177b8c4).

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #2237   +/-   ##
========================================
  Coverage    85.39%   85.39%           
========================================
  Files          353      353           
  Lines        31315    31315           
  Branches     31315    31315           
========================================
+ Hits         26740    26743    +3     
+ Misses        4193     4190    -3     
  Partials       382      382           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copilot stopped reviewing on behalf of josecelano due to an error September 16, 2026 15:31

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note

Copilot was unable to run its full agentic suite in this review.

Pull request overview

This PR updates the unified PR review process documentation for issue #2233 by tightening reviewer guidance (re-push scoping, re-raise rules, and checklist N/A semantics) and adding supporting evidence/design artifacts for deferred automation and path-reference conventions.

Changes:

  • Extend reviewer finding-template guidance to cover re-pushed heads, re-raised finding IDs, and checklist N/A usage.
  • Add issue-local evidence artifacts (manual verification, retrospective, agent review report) plus design notes (tiered routing, semantic-link conventions EPIC).
  • Record and classify non-resolving Markdown code-span “path-like” references and explicitly defer strict enforcement to a broader conventions EPIC.

Reviewed changes

Copilot reviewed 10 out of 11 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
docs/templates/REVIEW-FINDINGS.md Adds guidance for handling re-pushes and checklist N/A semantics in review findings.
.github/skills/dev/pr-reviews/review-pr/SKILL.md Updates reviewer skill guidance and formatting conventions; adds re-push scope and checklist rules.
.github/skills/dev/pr-reviews/process-pr-review/SKILL.md Adds workflow guidance for “retiring workflow docs” inventories and “rename purity” mechanical verification.
docs/issues/open/2233-2003-tune-unified-pr-review-process/ISSUE.md Updates #2233 spec to reflect delivered work, evidence, and deferral from checker implementation to conventions EPIC.
docs/issues/open/2233-2003-tune-unified-pr-review-process/tiered-model-routing-design.md Introduces design-only model-routing handoff roles and gates to preserve review independence.
docs/issues/open/2233-2003-tune-unified-pr-review-process/manual-verification-evidence.md Records human verification steps and observed results for the new guidance and design note.
docs/issues/open/2233-2003-tune-unified-pr-review-process/implementation-retrospective.md Captures implementation learnings and scope change rationale (deferral of strict path enforcement).
docs/issues/open/2233-2003-tune-unified-pr-review-process/code-span-path-case-analysis.md Summarizes taxonomy and recommended approach for path-like code spans in Markdown.
docs/issues/open/2233-2003-tune-unified-pr-review-process/code-span-path-case-inventory.tsv Provides the full inventory backing the T2 scope/deferral decision.
docs/issues/open/2233-2003-tune-unified-pr-review-process/agent-review-reports.md Persists independent review reports and follow-up items for the issue’s documentation changes.
docs/issues/drafts/refactor-semantic-link-conventions/EPIC.md Defines a draft EPIC to formalize future frontmatter/semantic-link/path-reference conventions and validation strategy.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread .github/skills/dev/pr-reviews/process-pr-review/SKILL.md Outdated
Comment thread docs/issues/open/2233-2003-tune-unified-pr-review-process/agent-review-reports.md Outdated
Comment thread docs/templates/REVIEW-FINDINGS.md Outdated
@josecelano

Copy link
Copy Markdown
Member Author

ACK 177b8c4

@josecelano
josecelano merged commit 678aa31 into torrust:develop Sep 16, 2026
19 checks passed
@josecelano
josecelano deleted the 2233-2003-tune-unified-pr-review-process branch September 16, 2026 16:34
josecelano added a commit that referenced this pull request Sep 17, 2026
bc6ad83 docs(issues): archive completed #2233 spec (Jose Celano)

Pull request description:

  Archives the completed #2233 issue specification after PR #2237 merged and GitHub closed the issue automatically.

  Related to #2233.

  ## Summary

  - Moves the #2233 issue folder from `docs/issues/open/` to `docs/issues/closed/`.
  - Updates #2233 metadata, progress log, and live self-references to the closed path.
  - Adds #2233 as a completed approved early implementation candidate in EPIC #2003.
  - Updates live references from the semantic-link conventions draft EPIC and PR #2237 audit.

  ## Validation

  - `linter markdown`
  - `linter cspell`
  - `linter lychee`
  - `git diff --check`
  - `bash contrib/dev-tools/checks/tests/test-agent-review-report-contract.sh`
  - `TORRUST_GIT_HOOKS_LOG_DIR=.tmp ./contrib/dev-tools/git/hooks/pre-commit.sh --format=text`

ACKs for top commit:
  josecelano:
    ACK bc6ad83

Tree-SHA512: 88b78179369b0042b0740eae10a64646fe18e869011502341d2109fc58df943b80689c60ce4e008db1ed46e8ad1ddbc4b95d7785747d31cd47bbae86402bc796
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Tune the unified PR review process from first-use evidence

2 participants