Contribution Guide
Thank you for considering contributing to Sake! To ensure a smooth collaboration, please follow the guidelines below before submitting your Pull Request:
Code Formatting and Testing
Before committing your code and opening a Pull Request, make sure to:
- Run code formatting:bash
sake format
- Run all tests to ensure everything is working as expected:bash
sake test
Commit Message Convention
Please use Conventional Commits for naming your commit messages. However, it's not required for every commit, as commits will be squashed upon merge, and the title of the Pull Request will be used. Therefore, this naming rule applies mainly to Pull Request titles.
The following groups are used in this project:
feat
: Featuresfix
: Bug Fixestest
: Testingperf
: Performancerefactor
: Refactoringdoc
: Documentationproject
: Project changes
If you do not use any of these categories in your Pull Request title, it will be placed in the "Other" group.
Here's an example of a proper Pull Request title:
feat: add support for new configuration option
Feel free to reach out if you have any questions or need further clarification.