Skip to content

Pull Request Workflow

Creating a PR

  1. Branch — Create from main: git checkout -b feature/your-feature
  2. Develop — Make changes, commit incrementally
  3. Test — Run npm run test:run and ensure all tests pass
  4. Build — Run npm run build to verify no build errors
  5. Push — Push your branch to your fork
  6. PR — Open a PR against main

PR Description

Include:

  • What — Brief description of the change
  • Why — Motivation and context
  • How — Technical approach
  • Testing — How you verified the change
  • Screenshots — For UI changes

Review Process

  1. Automated checks run (tests, build)
  2. Code review by maintainers
  3. Address feedback and update PR
  4. Approval and merge

After Merge

  • Delete your feature branch
  • Pull latest main to your local repo
  • Celebrate your contribution

Built with VitePress