Skip to content

feat(scaffold): point Next steps to the setup checklist (5q6.8) - #10

Open
R0SEWT wants to merge 1 commit into
mainfrom
feat/project-kit-5q6.8-setup-checklist-pointer
Open

R0SEWT wants to merge 1 commit into
mainfrom
feat/project-kit-5q6.8-setup-checklist-pointer

Conversation

@R0SEWT

@R0SEWT R0SEWT commented Oct 3, 2026 •

Copy link
Copy Markdown
Owner

Summary

The scaffold's "Next steps" now ends with a link to SETUP-CHECKLIST.md, the post-push manual steps (branch protection, reviewers).

Changes

  • One line in the Next steps heredoc of scripts/scaffold.sh.
  • Public URL, not a local path: scaffolded repos don't have project-kit checked out (the pending decision in 5q6.8's design).

Testing

  • bash -n scripts/scaffold.sh
  • shellcheck scripts/*.sh (0.11.0) — clean
  • scripts/scaffold.sh <tmp> --name demo --dry-run — the new line prints last in Next steps

Related

bd: project-kit-5q6.8

🤖 Generated with Claude Code

Summary by Sourcery

Enhancements:

  • Update scaffolded repository next steps to point users to the public setup checklist after their first push.

Scaffolded repos do not have project-kit checked out, so a local path would
dangle; the public URL keeps SETUP-CHECKLIST.md the single source of truth.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@sourcery-ai

sourcery-ai Bot commented Oct 3, 2026 •

Copy link
Copy Markdown
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

The scaffold script now directs users to the public setup checklist as the final Next steps item after their first push, helping them complete manual repository configuration such as branch protection and reviewer setup.

File-Level Changes

Change Details Files
Adds a post-push setup checklist link to the scaffolded repository’s Next steps instructions.
  • Appends a public GitHub URL for SETUP-CHECKLIST.md after the first-commit guidance.
  • Keeps the checklist reference external because scaffolded repositories do not contain project-kit locally.
scripts/scaffold.sh

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

@sourcery-ai sourcery-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.

Hey - I've found 1 issue

Prompt for AI Agents
Please address the comments from this code review:

## Individual Comments

### Comment 1
<location path="scripts/scaffold.sh" line_range="210" />
<code_context>
   - Fill in CLAUDE.md (Domain Context, Architecture, Key Files)
   - bd ready                 # start tracking work
   - git add -A && git commit # first commit
+  - After the first push: https://github.com/R0SEWT/project-kit/blob/main/SETUP-CHECKLIST.md
 EOF
</code_context>
<issue_to_address>
**issue:** The scaffolded Next steps link returns 404 because this repository does not currently contain `SETUP-CHECKLIST.md` on `main`, so users cannot access the checklist after following the new instruction.

**Triggers:** Until the checklist is merged to the repository's `main` branch.

**Suggested fix:** Merge the checklist change before this pointer, or land both changes together so the public URL resolves when scaffolding is released.
</issue_to_address>

Sourcery assessment

Approval pending. 1 finding to address first.

Blocking findings: scripts/scaffold.sh:210


Sourcery is free for open source - if you like our reviews please consider sharing them ✨

Comment thread scripts/scaffold.sh
- Fill in CLAUDE.md (Domain Context, Architecture, Key Files)
- bd ready # start tracking work
- git add -A && git commit # first commit
- After the first push: https://github.com/R0SEWT/project-kit/blob/main/SETUP-CHECKLIST.md

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

issue: The scaffolded Next steps link returns 404 because this repository does not currently contain SETUP-CHECKLIST.md on main, so users cannot access the checklist after following the new instruction.

Triggers: Until the checklist is merged to the repository's main branch.

Suggested fix: Merge the checklist change before this pointer, or land both changes together so the public URL resolves when scaffolding is released.

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