You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
docs: improve fork contribution workflow in CONTRIBUTING.md #218
CONTRIBUTING.md currently assumes contributors have direct push access to the repo. Contributors working from forks encountered several gaps that led to workflow mistakes:
No fork setup instructions — Getting Started shows git clone https://github.com/bradygaster/squad.git but does not explain how to fork first, clone the fork, and add upstream as a remote.
gh pr create has no --base dev flag — The Pull Request Process section says gh pr create with no base specified. This defaults to main, which is wrong. External contributors must target dev explicitly: gh pr create --base dev --repo bradygaster/squad --head username:branch.
Changeset not in the PR checklist — The Changesets section documents how to add a changeset, but the PR Process numbered list doesn't include it as a required step. Easy to skip.
Branch Strategy misleadingly describes bradygaster/dev — Currently says "Brady's integration branch (team usage)" which implies it's internal-only. It should clearly say it's the PR target for all contributions.
No guidance on rebasing before opening a PR — Nothing explains that the fork branch must be rebased on upstream/dev to avoid conflicts before creating the PR.
Proposed Changes
Add a "Contributing from a Fork" section covering the full fork workflow
Update Pull Request Process to specify --base dev and add changeset as a numbered step
Fix Branch Strategy description of bradygaster/dev
Add a "Keeping Your Fork in Sync" subsection with rebase instructions
Perfect docs improvements, @williamhallatt! Your fork workflow guide (setup, --base dev, changeset checklist, rebase advice) removes key friction points for external contributors. This is exactly the kind of docs update that scales community contributions. Really appreciate it! 📖
Activity
docs: add fork contribution workflow to CONTRIBUTING.md (github#218)
bradygaster commentedon Mar 7, 2026
✅ Fixed by PR #219 (merged commit 157b8c0) — fork contribution docs added.
Closed as part of v0.8.21 release wave cleanup.
bradygaster commentedon Mar 7, 2026
Perfect docs improvements, @williamhallatt! Your fork workflow guide (setup, --base dev, changeset checklist, rebase advice) removes key friction points for external contributors. This is exactly the kind of docs update that scales community contributions. Really appreciate it! 📖
— McManus 📝, on behalf of the Squad
docs: migration guide — GitHub-native to npm (github#218)