Thank you for considering contributing to this project! Please follow these guidelines to help us maintain a high-quality, welcoming, and consistent open-source ecosystem.
- Follow the instructions in the README to set up your environment.
- Use the provided .env.example as a template for environment variables.
- Use
feature/<name>for new features. - Use
fix/<name>for bug fixes. - Use
release/<version>for release preparation.
- Use Conventional Commits:
- feat: new features
- fix: bug fixes
- docs: documentation changes
- refactor: code refactoring
- test: adding or updating tests
- build/ci/chore: build or CI changes
- Ensure all tests pass.
- Lint your code.
- Update documentation if needed.
- Reference related issues.
- Add or update tests for new/changed code.
- Update README and docs for any user-facing changes.
- At least one maintainer must approve before merging.