docs(contributing): add a git workflow + /pr command#63
Open
bigmistqke wants to merge 2 commits into
Open
Conversation
commit: |
docs/superpowers is gitignored as internal process artifacts (specs + plans), but six files committed before that rule landed stayed tracked: the three design specs (via solidjs-community#62) and three plans (the commit that un-tracked plans lived on a deleted branch and never reached next-cleanup). Remove all six from the index (files stay on disk) so tracking matches the ignore rule.
bigmistqke
force-pushed
the
docs/contributing-git-workflow
branch
from
d2ad613 to
0883a45
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
1 participant
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.
Documents how we keep
main/next-cleanupreadable — messy branches, clean merges — adds a/prslash command that drafts a PR following those rules, and makes the repo's tracking match its.gitignore.What changed
mainor a sharedsolidjs-community/*branch); your own PR branch is yours to force-push/rebase/amend, shared branches are not; one PR = one logical change; squash by default (rebase only when every commit is already a clean, self-contained unit; never merge-commit); the PR title and body are the changelog, since squashing makes the title the commit subject and the description the commit body; and the "fixed points" note on per-commit pkg.pr.new previews. Purely additive — no existing prose changed..claude/commands/pr.md→ new/prcommand. Prepares a Conventional-Commit title, a changeset-style body, and a squash-vs-rebase recommendation for the current branch. Text only — it never pushes, force-pushes, or callsgh/the GitHub API. Encodes the same style rules (no hard-wrapping, noCo-Authored-Bytrailer, match the repo voice) so generated PRs match the documented workflow.docs/superpowersprocess artifacts. That tree is gitignored as internal process artifacts (design specs + plans), but six files committed before the ignore rule landed stayed tracked: the three design specs (via feat(xr)!: consumer-owned WebXR — decouple the frame loop from core; add createXR/useXR #62) and three plans (the commit that un-tracked plans lived on a now-deleted branch and never reachednext-cleanup).git rm --cachedremoves all six from the index — files stay on disk — so tracking matches the ignore rule. Repo-hygiene, same theme as the workflow docs.Test plan
pnpm lint:codelintssrc/**/*.{ts,tsx}only — Markdown is out of scope, nothing to run.git ls-files docs/superpowers/is empty after the change; the six files remain on disk (gitignored).