Skip to content

Workflow & Contribution Guide

Branching & PR Process

  • Use trunk-based development: short-lived feature branches, merge via PR to main.
  • All code changes require a pull request and code review.

Code Review & Testing

  • Automated tests must pass before merging.
  • Linting and style checks enforced.
  • Reviewers should check for clarity, security, and maintainability.

Adding Features or Fixes

  1. Create a feature branch from main.
  2. Implement changes with clear, descriptive commits.
  3. Write or update tests as needed.
  4. Open a pull request and request review.
  5. Address feedback and merge after approval.
  6. Updates to strategies ([design/strategies.md]) and architecture ([design/architecture.md]) should follow the same PR and review process.

Coding Standards

  • Follow language-specific best practices.
  • Write clear, maintainable, and well-documented code.

Documentation generated with VitePress