Version Control for Skyline/ProteoWizard
Before any Git or GitHub operation, read the relevant documentation:
Required Reading
- •ai/docs/version-control-guide.md - Commit message format, PR format, branch naming
- •ai/docs/release-cycle-guide.md - Current release phase, cherry-pick policy
- •ai/WORKFLOW.md - Git workflows, TODO system, branch lifecycle
Commit Message Format
<Title in past tense> * bullet point 1 * bullet point 2 See ai/todos/active/TODO-YYYYMMDD_feature.md Co-Authored-By: Claude <noreply@anthropic.com>
Rules:
- •Past tense title ("Added feature" not "Add feature")
- •Bullet points use
*prefix (not-) - •TODO reference required for feature branches
- •Co-Authored-By required when LLM contributed
- •Maximum 10 lines total
- •No emojis, no markdown links
pwiz-ai repository (ai/): Omit TODO reference for documentation-only changes
Amending Commits
Nearly all PRs get squash-merged, so multiple commits on a branch are fine.
When amending is appropriate:
- •Immediately after creating a PR, before any review or interaction
- •Local commits not yet pushed
When amending is NOT appropriate:
- •After a PR has been reviewed (even if just by Copilot)
- •After anyone has clicked "Update branch" on GitHub
- •After any merge commits from master
Instead of amending, just create a new commit. The commits will be squashed on merge anyway.
PR Description Format
## Summary * bullet point 1 * bullet point 2 Fixes #XXXX ## Test plan - [x] TestName - description Co-Authored-By: Claude <noreply@anthropic.com>
Rules:
- •Use
Co-Authored-By: Claude <noreply@anthropic.com>at the end (not emoji "Generated with" lines) - •Bullet points use
*prefix in Summary - •Test plan uses
- [x]checkboxes - •No emojis
Branch Naming
Skyline/work/YYYYMMDD_feature_name
Cherry-Pick to Release
When in FEATURE COMPLETE or patch mode, bug fix PRs should be cherry-picked to the release branch:
- •Check current release phase in
ai/docs/release-cycle-guide.md - •If fixing a bug during FEATURE COMPLETE: add label
Cherry pick to release - •The cherry-pick happens automatically after PR merge
Current release branch: Skyline/skyline_26_1 (check release-cycle-guide.md for updates)
Commands
Use /pw-pcommit or /pw-pcommitfull for guided commits.
See ai/docs/version-control-guide.md for complete specification.