PR Process

PR Process

This page describes the pull request workflow for RocketRide Engine, from branch creation through merge.

Branch Naming

All branches should follow this naming convention:

Pattern	Use For	Example
feature/*	New features	feature/add-mistral-vision
bugfix/*	Bug fixes	bugfix/fix-websocket-timeout
hotfix/*	Critical production fixes	hotfix/security-patch-auth

Target Branch

• All feature and bugfix PRs target develop (the integration branch).
• Hotfix PRs may target main directly for critical issues.
• The main branch is the stable release branch. It is updated only via merges from develop or hotfix branches.

Creating a PR

1. Push your branch:

   git push origin feature/your-feature-name

2. Open a PR on GitHub against develop.

3. Fill out the PR template with:

   • Description -- what changed and why
   • Related issues -- link to relevant GitHub issues (e.g., Closes #42)
   • Testing performed -- what you tested and how
   • Breaking changes -- any backward-incompatible changes

4. Use a semantic PR title following Conventional Commits format:

   • feat: add Mistral vision node
   • fix: resolve WebSocket timeout on large payloads
   • docs: update pipeline API wiki page

   CI will lint the PR title to enforce this format.

CI Checks

All PRs automatically run these checks:

• Build -- full build on Ubuntu, Windows, and macOS
• Tests -- all test suites (./builder test)
• Lint -- ESLint (TypeScript), Ruff (Python), code style checks
• PR title -- semantic PR title validation

All checks must pass before a PR can be merged.

Before Requesting Review

Make sure:

• All CI checks pass
• Your code follows the Code Style guidelines
• New code has appropriate tests
• Documentation is updated if needed
• The PR description clearly explains the change
• You have rebased on the latest develop to avoid merge conflicts

Review Process

1. Request a review from a maintainer.
2. Address all review feedback with new commits (do not force-push during review unless asked).
3. Once approved, a maintainer will merge the PR.

Merge Strategy

PRs are merged into develop using a merge commit. Squash merges may be used for small, single-purpose PRs at the maintainer's discretion.

After Merge

After your PR is merged into develop:

• Delete your feature branch (GitHub offers this automatically).
• Periodically, develop is merged into main for releases. See Release Process.

Next Steps

• How to Contribute -- full contribution workflow
• Code Style -- language-specific guidelines
• Release Process -- how releases are cut