docs: setup-checklist for post-push manual steps (5q6.3)#1
Merged
Conversation
Reviewer's GuideAdds 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 checklistflowchart 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
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
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.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
There was a problem hiding this comment.
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.
1b6673a to
b10e696
Compare
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.
b10e696 to
1f0c2bf
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.
* @ownerCODEOWNERS self-block).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).