Skip to content

chore(github): ask for the issue link, spec, pictures and docs in issues and pull requests - #85

Merged
jddunn merged 2 commits into
masterfrom
templates/tracked-work
Nov 2, 2026
Merged

jddunn merged 2 commits into
masterfrom
templates/tracked-work

Conversation

@jddunn

@jddunn jddunn commented Nov 2, 2026 •

Copy link
Copy Markdown
Member

What changed

Adds the tracked-work issue form, for work that takes more than one pull request. The pull request template asks for the issue link, the spec, plan and design, and pictures, beside its existing docs item.

Issue

No issue

Spec, plan and design

None

Pictures

No visible change

Docs

The template is the doc.

Tests

None. GitHub renders it on the next issue or pull request.

Summary by CodeRabbit

  • Documentation
    • Added an issue template for tracking work planned across multiple pull requests, with required sections for outcomes, plans, visuals, documentation updates, tasks, and completion checks.
    • Updated the pull request template with guidance for linking related issues, sharing relevant plans or designs, and including before-and-after images or noting when there is no visible change.

@sourcery-ai

sourcery-ai Bot commented Nov 2, 2026

Copy link
Copy Markdown

Sorry @jddunn, you've used your own review budget of 250,000 diff characters for the last 7 days.

You can request another review in 55 minutes by commenting @sourcery-ai review. Upgrade to get a review now.

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Nov 2, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-11-02T02:07:34.810286Z 2c0b9f2 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@sourcery-ai

sourcery-ai Bot commented Nov 2, 2026

Copy link
Copy Markdown

Reviewer's Guide

Introduces GitHub templates that distinguish multi-pull-request tracked work from standalone changes and require consistent issue links, planning/design context, visual evidence, documentation details, task tracking, and completion criteria.

File-Level Changes

Change Details Files
Adds a structured GitHub issue form for multi-PR tracked work.
  • Defines required fields for outcome, specification/design, plan, screenshots, documentation, tasks, and completion criteria.
  • Sets issue metadata and explains how constituent pull requests should reference and close the tracked issue.
.github/ISSUE_TEMPLATE/tracked-work.yml
Expands the pull request template to capture traceability and implementation context.
  • Replaces the generic issue prompt with guidance for using “Closes #n”, “Part of #n”, or “No issue”.
  • Adds sections for specification, plan, design, and before/after pictures, including explicit no-change options.
.github/pull_request_template.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@qodo-free-for-open-source-projects

Copy link
Copy Markdown

PR Summary by Qodo

Add tracked-work issue form and expand pull request prompts

⚙️ Configuration changes 📝 Documentation 🕐 Less than 10 minutes

Grey Divider

AI Description

• Add an issue form for work spanning multiple pull requests, with plans, tasks, and completion
 criteria.
• Ask pull request authors to identify related issues, link specifications, and provide pictures for
 visible changes.
• Clarify when to use “Part of,” “Closes,” or “No issue.”
Diagram

graph TD
  IssueForm["Tracked work form"] --> TrackedIssue["Tracked issue"] --> EarlyPR["Earlier PRs"] --> FinalPR["Final PR"] --> ClosedIssue["Closed issue"]
  PRTemplate["PR template"] --> EarlyPR
  PRTemplate --> FinalPR
Loading
High-Level Assessment

GitHub's native issue form and PR template put prompts where contributors create work. Contributor documentation alone would not provide the same in-flow guidance.

Files changed (2) +73 / -1

Documentation (1) +12 / -1
pull_request_template.mdPrompt PR authors for issue status and supporting material +12/-1

Prompt PR authors for issue status and supporting material

• Replaces the fixed “Fixes #” prompt with guidance for “Closes,” “Part of,” or “No issue.” Adds sections for spec, plan and design links and before-and-after pictures, while retaining the existing docs checklist item.

.github/pull_request_template.md

Other (1) +61 / -0
tracked-work.ymlAdd a form for multi-PR tracked work +61/-0

Add a form for multi-PR tracked work

• Adds an issue form labeled “track” that requests the shipped outcome, spec or design, plan, pictures, docs, tasks, and completion criteria. Its guidance reserves tracked issues for work spanning multiple PRs and explains how the final PR closes the issue.

.github/ISSUE_TEMPLATE/tracked-work.yml

@qodo-free-for-open-source-projects

Copy link
Copy Markdown

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Grey Divider

Great, no issues found!

Qodo reviewed your code and found no material issues that require review

Grey Divider

Tip of the day
💡 Did you know, you can copy the agent prompt from any finding and feed it to your IDE agent

More tips ↗ | Customize Qodo ↗ | Qodo docs ↗

Grey Divider

Qodo Logo

@coderabbitai

coderabbitai Bot commented Nov 2, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Warning

Review limit reached

  • Run on-demand review

This review includes 2 billable files and costs up to $0.50.

  • Ask an admin to make reviews automatic

Open in CodeRabbit

Reviews can continue after your included limit without a manual trigger. An admin must approve usage-based billing.

Or wait 44 minutes for your next included review.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available. Your 99 included PR review attempts over the past 7 days set your current allowance at 1 review per hour.

Learn how review limits work.

Review configuration:

Run configuration
Commits

Reviewing files that changed from the base of the PR and between 2c0b9f2 and 3e5c0ff.

Files selected for processing: 2
  • .github/ISSUE_TEMPLATE/tracked-work.yml
  • .github/pull_request_template.md

No actionable comments were generated in the recent review.

Recent review info
Run configuration
Commits

Reviewing files that changed from the base of the PR and between f53f366 and 2c0b9f2.

Files selected for processing: 2
  • .github/ISSUE_TEMPLATE/tracked-work.yml
  • .github/pull_request_template.md

Included review availability: This review used your included allowance. 0 included reviews remain after this review. Your included PR review attempts over the past 7 days set your current allowance at 1 review per hour.

Walkthrough

The issue template adds required fields for tracking multi-pull-request work. The pull request template updates issue-link guidance and adds prompts for specifications, plans, designs, and pictures.

Changes: Tracked Work Templates

Layer / File(s) Summary
Tracked work issue intake
.github/ISSUE_TEMPLATE/tracked-work.yml
Adds a required template for the outcome, spec or design, plan, visual changes, documentation, tasks, and completion checks.
Pull request links and supporting details
.github/pull_request_template.md
Replaces the issue prompt with guidance for “Closes #n,” “Part of #n,” or “No issue.” Adds prompts for specs, plans, designs, and pictures.

Estimated code review effort: 2 (Simple) | ~8 minutes

Change: Other

Merge Risk: Minimal · previous review 2c0b9

The template-only changes introduce no identified runtime, build, security, or data-integrity risk and are ready to merge.

Pre-merge checks: Passed 5
Check name Status Explanation
Title check Passed The title clearly describes the main changes to issue and pull request templates. It is concise and specific.
Description check Passed The description explains the template changes, issue status, design status, visual change status, documentation, and testing. It does not use the required Summary, Checklist, and Related headings, and…
Docstring Coverage Passed No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
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.
Full details: Description check

Explanation

The description explains the template changes, issue status, design status, visual change status, documentation, and testing. It does not use the required Summary, Checklist, and Related headings, and it does not state why the change is needed. However, it is mostly complete and directly related to the changes.

Full details: Docstring Coverage

Explanation

No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (2 skipped: 2 unsupported.)

Finishing Touches
Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

@codecov

codecov Bot commented Nov 2, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

…e the title and tasks, and ask to hide secrets in pictures
@jddunn
jddunn merged commit c6d1a20 into master Nov 2, 2026
7 checks passed
@jddunn
jddunn deleted the templates/tracked-work branch November 2, 2026 02:55
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