|
| 1 | +# Contributing to codemirror-sql |
| 2 | + |
| 3 | +Thanks for your interest in contributing! Here's how you can help: |
| 4 | + |
| 5 | +## Development Setup |
| 6 | + |
| 7 | +1. Fork and clone the repo |
| 8 | +2. Install dependencies: `pnpm install` |
| 9 | +3. Run tests: `pnpm test` |
| 10 | +4. Start dev environment: `pnpm dev` |
| 11 | + |
| 12 | +## Development Process |
| 13 | + |
| 14 | +1. Create a feature branch: `git checkout -b feature-name` |
| 15 | +2. Make your changes |
| 16 | +3. Run tests: `pnpm test` |
| 17 | +4. Run type checks: `pnpm typecheck` |
| 18 | +5. Run linting: `pnpm lint` |
| 19 | +6. Commit your changes using conventional commits |
| 20 | +7. Push to your fork and submit a pull request |
| 21 | + |
| 22 | +## Pull Request Guidelines |
| 23 | + |
| 24 | +- Include tests for any new functionality |
| 25 | +- Update documentation for API changes |
| 26 | +- Follow the existing code style |
| 27 | +- Keep PRs focused - one feature/fix per PR |
| 28 | + |
| 29 | +## Commit Messages |
| 30 | + |
| 31 | +We use conventional commits. Format: |
| 32 | + |
| 33 | +```markdown |
| 34 | +type(scope): description |
| 35 | + |
| 36 | +[optional body] |
| 37 | +[optional footer] |
| 38 | +``` |
| 39 | + |
| 40 | +Types: |
| 41 | + |
| 42 | +- feat: New feature |
| 43 | +- fix: Bug fix |
| 44 | +- docs: Documentation only |
| 45 | +- style: Code style changes |
| 46 | +- refactor: Code changes that neither fixes a bug nor adds a feature |
| 47 | +- perf: Performance improvements |
| 48 | +- test: Adding or updating tests |
| 49 | +- chore: Changes to build process or auxiliary tools |
| 50 | + |
| 51 | +## Release Process |
| 52 | + |
| 53 | +For maintainers only: |
| 54 | + |
| 55 | +```bash |
| 56 | +git checkout main |
| 57 | +git pull |
| 58 | +npx bumpp --no-git-check=false |
| 59 | +``` |
| 60 | + |
| 61 | +## Questions? |
| 62 | + |
| 63 | +Open an issue or discussion if you have questions! |
0 commit comments