corva-dc-platform-shared

A repository to share Dev Center platform code

Contributing Guide

Quick Start

1. Branch Setup

   git checkout develop
   git pull
   git checkout -b feature/your-feature   # or fix/your-fix

2. Development

   • Write code
   • Add tests
   • Run:

     yarn install
     yarn lint
     yarn test

3. Create PR

   • Push to your branch
   • Create PR to develop
   • PR title must follow conventional commits:

     feat: add user authentication
     fix: resolve login error
     feat!: change API response format
     

Branch Strategy

• develop - main development branch
• feature/* - new features
• fix/* - bug fixes
• No direct commits to develop

Release Process

1. Get your PR merged to develop
2. Release Please automatically:
   • Creates release PR
   • Updates version based on commits
   • Generates changelog
3. Merge the Release Please PR
4. System automatically:
   • Creates git tag
   • Runs E2E tests
   • Publishes to NPM

Version Bumping

• Automatic based on PR titles:
  • fix: → 0.0.X
  • feat: → 0.X.0
  • feat!: or BREAKING CHANGE: → X.0.0
• Never modify version manually

CI Checks

Your PR must pass:

• Linting
• Unit tests
• E2E tests (feature/fix branches)
• PR title validation
• Code review

Remember: The key is writing good code and using correct commit conventions - the release process is automated!