|
| 1 | +# Contributing to Mizzle ORM |
| 2 | + |
| 3 | +Thank you for your interest in contributing to Mizzle ORM! |
| 4 | + |
| 5 | +## Development Setup |
| 6 | + |
| 7 | +1. Fork and clone the repository |
| 8 | +2. Install dependencies: |
| 9 | + ```bash |
| 10 | + pnpm install |
| 11 | + ``` |
| 12 | +3. Build the project: |
| 13 | + ```bash |
| 14 | + pnpm build |
| 15 | + ``` |
| 16 | +4. Run tests: |
| 17 | + ```bash |
| 18 | + pnpm test |
| 19 | + ``` |
| 20 | + |
| 21 | +## Project Structure |
| 22 | + |
| 23 | +This is a monorepo managed with pnpm workspaces and Turborepo: |
| 24 | + |
| 25 | +``` |
| 26 | +mizzle-orm/ |
| 27 | +├── packages/ |
| 28 | +│ └── mizzle-orm/ # Core ORM package |
| 29 | +├── .changeset/ # Changesets for versioning |
| 30 | +├── .github/ # GitHub Actions workflows |
| 31 | +└── turbo.json # Turborepo configuration |
| 32 | +``` |
| 33 | + |
| 34 | +## Making Changes |
| 35 | + |
| 36 | +1. Create a new branch: |
| 37 | + |
| 38 | + ```bash |
| 39 | + git checkout -b feature/your-feature-name |
| 40 | + ``` |
| 41 | + |
| 42 | +2. Make your changes in the appropriate package |
| 43 | + |
| 44 | +3. Add tests for your changes |
| 45 | + |
| 46 | +4. Run the test suite: |
| 47 | + |
| 48 | + ```bash |
| 49 | + pnpm test |
| 50 | + ``` |
| 51 | + |
| 52 | +5. Create a changeset: |
| 53 | + |
| 54 | + ```bash |
| 55 | + pnpm changeset |
| 56 | + ``` |
| 57 | + |
| 58 | +6. Commit your changes following [Conventional Commits](https://www.conventionalcommits.org/): |
| 59 | + |
| 60 | + ``` |
| 61 | + feat: add new feature |
| 62 | + fix: fix bug |
| 63 | + docs: update documentation |
| 64 | + chore: update dependencies |
| 65 | + ``` |
| 66 | + |
| 67 | +7. Push and create a pull request |
| 68 | + |
| 69 | +## Code Style |
| 70 | + |
| 71 | +- We use Prettier for code formatting |
| 72 | +- We use ESLint for linting |
| 73 | +- Run `pnpm format` before committing |
| 74 | + |
| 75 | +## Testing |
| 76 | + |
| 77 | +- Write tests for all new features |
| 78 | +- Ensure all tests pass before submitting a PR |
| 79 | +- Aim for high test coverage |
| 80 | + |
| 81 | +## Pull Request Process |
| 82 | + |
| 83 | +1. Ensure your PR has a clear description of the changes |
| 84 | +2. Link any related issues |
| 85 | +3. Ensure all CI checks pass |
| 86 | +4. Request review from maintainers |
| 87 | +5. Address any feedback |
| 88 | + |
| 89 | +## Release Process |
| 90 | + |
| 91 | +Releases are automated using Changesets: |
| 92 | + |
| 93 | +1. Changesets are created during development |
| 94 | +2. On merge to main, a release PR is automatically created |
| 95 | +3. Merging the release PR publishes to npm |
| 96 | + |
| 97 | +## Questions? |
| 98 | + |
| 99 | +Feel free to open an issue for any questions or concerns! |
0 commit comments