Skip to content

docs: setup-checklist for post-push manual steps (5q6.3)#1

Merged
R0SEWT merged 1 commit into
mainfrom
docs/setup-checklist
Jun 4, 2026
Merged

docs: setup-checklist for post-push manual steps (5q6.3)#1
R0SEWT merged 1 commit into
mainfrom
docs/setup-checklist

Conversation

@R0SEWT
Copy link
Copy Markdown
Owner

@R0SEWT R0SEWT commented Jun 4, 2026

Closes the doc half of project-kit-5q6.3: capture the account/repo-settings steps the scaffold can't commit but a minimal collab-ready repo wants.

Scope (inclusion criterion stated in the doc): only steps that (a) can't be committed and (b) belong on a minimal collab-ready repo.

  • Branch protection / require-review — with the solo-dev traps (your own approval doesn't count on your own PR; * @owner CODEOWNERS self-block).
  • Copilot automatic code review — account/repo toggle (not a committable file), enabled as an independent ruleset (no merge-gate needed since Sept 2025); needs a paid Copilot plan (Pro = entry tier). Trap: Copilot leaves a Comment review, which does not satisfy a require-approval rule.
  • Note — Actions-minute billing for Copilot review on private repos as of 2026-06-01 (public stays free).
  • Explicit out-of-scope line so it can't sprawl.

Facts web-verified at authoring time (the "Pro/Pro+" memory was corrected to "any paid plan, Pro entry tier").

Does not touch scaffold.sh: the scaffold pointer to this doc is a separate, intentionally-deferred bead (5q6.8; public-URL-vs-local-path decision made there).

Copilot AI review requested due to automatic review settings June 4, 2026 02:37
@sourcery-ai
Copy link
Copy Markdown

sourcery-ai Bot commented Jun 4, 2026

Reviewer's Guide

Adds a new SETUP-CHECKLIST.md document that captures post-push, non-committable GitHub settings needed for a minimal, collaboration-ready repository, including branch protection/require-review guidance, Copilot automatic code review setup, and a billing note for Copilot-related Actions usage.

Flow diagram for post-push GitHub setup checklist

flowchart TD
  Start([First push of new repo])
  BranchProtection[Configure branch protection and require_review]
  SoloDev{Working solo?}
  Approvals[Require approvals and use second human/account]
  NoApprovals[Do not require approvals (or add later)]
  CopilotReview[Enable Copilot automatic code review ruleset]
  BillingNote[Be aware Copilot review uses Actions minutes on private repos]
  End([Repo is minimally collab-ready])

  Start --> BranchProtection
  BranchProtection --> SoloDev
  SoloDev -->|Yes| Approvals
  SoloDev -->|No| NoApprovals
  Approvals --> CopilotReview
  NoApprovals --> CopilotReview
  CopilotReview --> BillingNote
  BillingNote --> End
Loading

File-Level Changes

Change Details Files
Document post-push GitHub configuration steps that cannot be committed but are recommended for a minimal collaboration-ready repo.
  • Create a new SETUP-CHECKLIST.md describing manual account/repo settings to perform after first push.
  • Clarify the inclusion scope to only non-committable settings appropriate for a minimal collab-ready repository and explicitly exclude advanced, project-specific configuration.
  • Explain how to configure branch protection and required reviews on the default branch, including solo-developer edge cases around self-approval and CODEOWNERS ownership.
  • Describe how to enable GitHub Copilot automatic code review as an independent ruleset, its licensing requirements, and the limitation that its reviews are comments that do not satisfy approval requirements.
  • Add an informational note that Copilot code review now consumes GitHub Actions minutes on private repositories as of June 1, 2026, while remaining free on public repositories.
SETUP-CHECKLIST.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

Copy link
Copy Markdown

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

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

Hey - I've left some high level feedback:

  • The doc hardcodes time-bound details (e.g., 'since Sept 2025', 'Since June 1, 2026', specific Copilot pricing) that may go stale quickly; consider rephrasing to be less date/price-specific or linking to GitHub’s official docs for current behavior and pricing instead.
  • The note about org members using Copilot 'with no license if the org enables the policy' could be clarified or linked to GitHub’s policy docs, since licensing rules are nuanced and may vary by plan and organization settings.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- The doc hardcodes time-bound details (e.g., 'since Sept 2025', 'Since June 1, 2026', specific Copilot pricing) that may go stale quickly; consider rephrasing to be less date/price-specific or linking to GitHub’s official docs for current behavior and pricing instead.
- The note about org members using Copilot 'with no license if the org enables the policy' could be clarified or linked to GitHub’s policy docs, since licensing rules are nuanced and may vary by plan and organization settings.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot reviewed 1 out of 1 changed files in this pull request and generated no comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

R0SEWT added a commit that referenced this pull request Jun 4, 2026
ShellCheck SC2018/SC2019 on scaffold.sh:57 — tr 'A-Z' 'a-z' is flagged
because plain ranges don't cover accents/foreign alphabets. Switch to
tr '[:upper:]' '[:lower:]'. No behavior change for ASCII names; turns the
lint CI job green so PR #1 can merge.
@R0SEWT R0SEWT force-pushed the docs/setup-checklist branch from 1b6673a to b10e696 Compare June 4, 2026 06:27
Account/repo settings the scaffold can't commit but a minimal collab-ready
repo wants: branch protection / require-review (with the solo-dev approval
traps), Copilot automatic code review (account toggle; paid Copilot plan,
Pro entry tier; Comment-type review does not satisfy require-approval), and
an awareness note on Actions-minute billing for Copilot review on private
repos as of 2026-06-01.
@R0SEWT R0SEWT force-pushed the docs/setup-checklist branch from b10e696 to 1f0c2bf Compare June 4, 2026 06:29
@R0SEWT R0SEWT merged commit c76934e into main Jun 4, 2026
4 checks passed
@R0SEWT R0SEWT deleted the docs/setup-checklist branch June 4, 2026 06:37
R0SEWT added a commit that referenced this pull request Jun 4, 2026
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.

2 participants