First of all, thank you for taking the time to contribute! ๐
When contributing to commitizen, please first create an issue to discuss the change you wish to make before making a change.
If you're a first-time contributor, you can check the issues with good first issue tag.
Before making a pull request
- Fork the repository
- Clone the repository from you GitHub
- Setup development environment through poetry (
poetry install) - Check out a new branch and add your modification
- Add test cases for all your changes
(We use CodeCov to ensure our test coverage does not drop.) - Use commitizen to do git commit
- Run
./scripts/lintand./scripts/testto ensure you follow the coding style and the tests pass - Update
READMD.mdandCHANGELOG.mdfor your changes - Send a pull request ๐