Skip to content
JaypieJaypie

Branch Management

Prerequisites: Git

Overview

Section titled “Overview”

Jaypie uses a simple branch workflow with main as the primary branch and feature branches for development.

Branch Naming

Section titled “Branch Naming”

Ticket-Based

Section titled “Ticket-Based”
feat/TICKET-ID
feat/DEV-123
feat/GITHUB-456

Description-Based

Section titled “Description-Based”
feat/short-description-abc12345


# Pattern: feat/{2-3 word description}-{first 8 chars of commit hash}

Naming Guidelines

Section titled “Naming Guidelines”
  • Lead with most important word
  • 2-3 words maximum
  • Use hyphens, not underscores
  • Lowercase

Examples

Section titled “Examples”
Good Bad
feat/streaming-handler feat/add_new_streaming_handler_for_sse
fix/lambda-timeout fix/FixTheLambdaTimeoutBug
feat/DEV-123 feature/DEV-123-implement-user-auth

Workflow

Section titled “Workflow”

1. Create Branch

Section titled “1. Create Branch”
Terminal window
git checkout main
git pull
git checkout -b feat/description-abc12345

2. Make Commits

Section titled “2. Make Commits”
Terminal window
# After each validated change
git add .
git commit -m "type: scope: description"

3. Push Branch

Section titled “3. Push Branch”
Terminal window
git push -u origin feat/description-abc12345

4. Create PR

Section titled “4. Create PR”

Create pull request via GitHub CLI or web interface.

Pull Request Process

Section titled “Pull Request Process”

PR Title

Section titled “PR Title”

Same format as commit:

feat: express: add streaming handler

PR Description

Section titled “PR Description”
## Summary


- Added expressStreamHandler for SSE responses
- Added createExpressStream helper


## Test plan


- [ ] Run `npm test -w packages/express`
- [ ] Test streaming locally with `npm run dev`

Creating PR

Section titled “Creating PR”
Terminal window
gh pr create --title "feat: express: add streaming handler" --body "..."

Branch Protection

Section titled “Branch Protection”

main branch is protected:

  • Requires PR review
  • Requires passing CI
  • No direct pushes

CI Triggers

Section titled “CI Triggers”
Branch Pattern Workflow
feat/* npm-check.yml
fix/* npm-check.yml
main npm-deploy.yml
deploy-* npm-deploy.yml

Keeping Branch Updated

Section titled “Keeping Branch Updated”

Rebase (Preferred)

Section titled “Rebase (Preferred)”
Terminal window
git fetch origin
git rebase origin/main

Merge (If Conflicts Complex)

Section titled “Merge (If Conflicts Complex)”
Terminal window
git fetch origin
git merge origin/main

Cleaning Up

Section titled “Cleaning Up”

After PR Merged

Section titled “After PR Merged”
Terminal window
git checkout main
git pull
git branch -d feat/old-branch

Delete Remote Branch

Section titled “Delete Remote Branch”

GitHub auto-deletes after merge, or manually:

Terminal window
git push origin --delete feat/old-branch

Commit Best Practices

Section titled “Commit Best Practices”

Small Commits

Section titled “Small Commits”

Each commit should be:

  • Single logical change
  • Independently buildable
  • Self-contained (tests pass)

Commit Often

Section titled “Commit Often”

Commit after each successful validation step. Creates restore points.

Don’t Commit

Section titled “Don’t Commit”
  • Broken code
  • Failing tests
  • Unfinished changes
Section titled “Related”