We're excited to have you contribute. Before you get started, please take a moment to review this guide to understand how to contribute effectively.
Before you begin contributing to Htmst, make sure you have the following installed.
- Python 3.12 or later
- uv 0.5.4 or later
-
Navigate to the project folder
cd htmst -
Sync the project dependencies
uv sync --all-groups
-
Install pre-commit hooks
pre-commit install
pre-commit install-hooks
-
Create a branch
git checkout -b feature/my-feature
-
Write code
Write your code, following the project's coding standards.
-
Test your changes
Run the test suite to ensure your changes are working as expected.
uv run pytest
Or run the test suite with watch mode to automatically re-run tests when you make changes.
uv run ptw . -
Commit changes
Use meaningful commit messages. If your change fixes a specific issue, reference it in the commit message
git commit -m "Your commit message" -
Push changes
Push your changes to your forked repository
git push origin feature/my-feature
-
Once your changes are ready, open a pull request on the main repository. Provide a clear description of your changes and reference any related issues.
-
Review and iterate
Collaborate with maintainers and other contributors to address any feedback on your pull request. Make necessary changes and push them to the same branch.
-
Get your pull request approved
Once your pull request is approved, it will be merged into the main branch. Congratulations on your contribution!
Thank you for contributing! 🎉 We appreciate your help in making this project better.