Thanks for your interest in contributing to this project!
The project uses uv for managing development dependencies. To set up your development environment, follow these steps:
- Install uv if you haven't already:
- Clone the repository
- Navigate to the project directory
- Run the following command to install development dependencies:
uv sync --dev
- Install pre-commit hooks:
uvx pre-commit install
- Make your changes and be sure to add tests if applicable.
- Run tests to ensure everything is working:
uv run pytest tests
- Commit your changes following the conventional commit guidelines.
- Push your changes and create a pull request.
- Thank you for contributing!
To publish a new version of the cz-mono package, follow these steps:
-
Ensure all tests pass and your changes are committed.
-
Bump the version using Commitizen:
cz bump
-
Push the changes to the remote repository:
git push origin master --tags
-
This will trigger the CI/CD pipeline to build and publish the new version to PyPI and add a new release on GitHub.
-
Verify that the new version is available on PyPI and that the GitHub release has been created successfully.
-
Celebrate your successful release! 🎉