Skip to content

recoup-internal-dev-issue-tracker: make the PRs matrix a required section#58

Open
sweetmantech wants to merge 1 commit into
mainfrom
docs/issue-tracker-prs-matrix
Open

recoup-internal-dev-issue-tracker: make the PRs matrix a required section#58
sweetmantech wants to merge 1 commit into
mainfrom
docs/issue-tracker-prs-matrix

Conversation

@sweetmantech

@sweetmantech sweetmantech commented Jun 25, 2026

Copy link
Copy Markdown
Contributor

Why

The PRs matrix (PR | Item | Base | State, directly under ## Goal) is one of the most important parts of a tracking issue — it's the only at-a-glance view of the whole PR fleet and its state. Both gold-standard trackers carry it (chat#1813, and now chat#1815).

But the skill never required it: it wasn't in the Anatomy section list, had no format spec, and wasn't in the checklist. So a follow-up tracker (chat#1815) shipped with the PRs named only in prose and no matrix — exactly the gap this fixes.

What changed

  • Anatomy list — add ## PRs as item 3, directly under Goal.
  • New section "The PRs matrix (required for any multi-PR tracker)" — (updated <ISO>) heading for visible staleness, the four columns (PR / Item / Base / State), per-column rules, the ✅ merged/🔄 open state convention, and the merge-sequencing follow-up blockquote.
  • Checklist — a non-negotiable gate so it can't be skipped again.

Verification

All five repo gates pass: portability_lint, check_vendored, validate_manifests, check_resolvable, run_resolver_eval. File is not vendored (no vendored.json re-sync needed).

🤖 Generated with Claude Code


Summary by cubic

Make the PRs matrix mandatory in the tracking-issue skill to give a single, at-a-glance view of all related PRs. Adds a clear spec, required placement under Goal, and a checklist gate to prevent omissions.

  • New Features

    • Added ## PRs to the Anatomy list (item 3, under Goal).
    • New "The PRs matrix" spec: (updated <ISO>) heading, four columns (PR, Item, Base, State), per-column rules, ✅/🔄 state convention, and a merge-sequencing note.
    • Checklist updated with a non-negotiable gate.
  • Migration

    • For multi-PR trackers, add the table directly under ## Goal with (updated <ISO date>).
    • Keep State current; keep merged rows; put closure notes under ## Done.
    • Add a short sequencing note when merge order matters.

Written for commit d53afa0. Summary will update on new commits.

Review in cubic

Summary by CodeRabbit

  • Documentation
    • Clarified the required structure for multi-PR tracking issues.
    • Added a mandatory PRs matrix under Goal with clear status and merge-order guidance.
    • Tightened the pre-post/update checklist so tracking issues must include the updated PR table format.

…tion

The PRs matrix (PR | Item | Base | State, directly under Goal) is one of the
most important parts of a tracker, but it was never listed in the Anatomy
section, had no format spec, and wasn't in the checklist — so it got omitted
from follow-up trackers (e.g. chat#1815) that linked several PRs only in prose.

- Add `## PRs` to the Anatomy list (item 3, directly under Goal).
- Add a "The PRs matrix (required for any multi-PR tracker)" section: heading
  with `(updated <ISO>)`, the four columns, per-column rules, and the
  merge-sequencing follow-up.
- Add a checklist gate so it can't be skipped again.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Jun 25, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The skill document now requires a ## PRs matrix immediately under ## Goal for multi-PR tracking issues, defines the table columns and state notation, and adds a checklist item to keep that section present and updated.

Changes

Multi-PR tracker format

Layer / File(s) Summary
PR matrix requirement
skills/recoup-internal-dev-issue-tracker/SKILL.md
Adds the required ## PRs (updated <ISO date>) matrix under ## Goal, defines the PR / Item / Base / State columns and state labels, and adds a checklist rule for keeping it current.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

I hopped through the tracker with a twitch of my nose,
Found PRs in a matrix where the soft goal grows.
✅ merged, 🔄 open, neat as a row,
I twitched my ears happily — “onward I go!” 🐰

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly matches the main change: making the PRs matrix a required section in the issue-tracker skill.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/issue-tracker-prs-matrix

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot 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.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@skills/recoup-internal-dev-issue-tracker/SKILL.md`:
- Around line 39-47: The example fence in the PR list section is missing a
language tag and is triggering MD040. Update the fenced block in the PRs table
example to use a Markdown-labeled fence, keeping the rest of the snippet
unchanged so the docs lint passes cleanly.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 45684fdc-00db-41ba-bab2-c23c72fe3799

📥 Commits

Reviewing files that changed from the base of the PR and between de43931 and d53afa0.

📒 Files selected for processing (1)
  • skills/recoup-internal-dev-issue-tracker/SKILL.md

Comment on lines +39 to +47
```
## PRs (updated 2026-06-25)

| PR | Item | Base | State |
|----|------|------|-------|
| [docs#251](url) | `POST /api/emails` send-email contract (OpenAPI + types + nav) | `main` | 🔄 open — preview-verified; merge first |
| [api#708](url) | `POST /api/emails` endpoint + route ephemeral key to `RECOUP_API_KEY` (auth fix) | `test` | 🔄 open — preview-verified end-to-end |
| [tasks#153](url) | retire dead `run-sandbox-command` task (OpenClaw Phase 2 cleanup) | `main` | 🔄 open — 355 tests pass, grep clean |
```

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Tag the example fence as Markdown.

This snippet will trip MD040 as written. Add a markdown fence tag so the docs lint stays clean.

Suggested edit
-```
+```markdown
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
```
## PRs (updated 2026-06-25)
| PR | Item | Base | State |
|----|------|------|-------|
| [docs#251](url) | `POST /api/emails` send-email contract (OpenAPI + types + nav) | `main` | 🔄 open — preview-verified; merge first |
| [api#708](url) | `POST /api/emails` endpoint + route ephemeral key to `RECOUP_API_KEY` (auth fix) | `test` | 🔄 open — preview-verified end-to-end |
| [tasks#153](url) | retire dead `run-sandbox-command` task (OpenClaw Phase 2 cleanup) | `main` | 🔄 open — 355 tests pass, grep clean |
```
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)

[warning] 39-39: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@skills/recoup-internal-dev-issue-tracker/SKILL.md` around lines 39 - 47, The
example fence in the PR list section is missing a language tag and is triggering
MD040. Update the fenced block in the PRs table example to use a
Markdown-labeled fence, keeping the rest of the snippet unchanged so the docs
lint passes cleanly.

Source: Linters/SAST tools

@cubic-dev-ai cubic-dev-ai Bot 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.

No issues found across 1 file

Re-trigger cubic

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.

1 participant