The easiest way to contribute to TinyTemplate is to use it and report your experiences, ask questions and contribute ideas. We'd love to hear your thoughts on how to make TinyTemplate better, or your comments on why you are or are not currently using it.
Issues, ideas, requests and questions should be posted on the issue tracker at:
https://github.com/bheisler/TinyTemplate/issues
Pull requests are welcome, though please raise an issue or post a comment for discussion first. We're happy to assist new contributors.
If you're not sure what to work on, try checking the Beginner label
To make changes to the code, fork the repo and clone it:
git clone git@github.com:your-username/TinyTemplate.git
Then make your changes to the code. When you're done, run the tests:
cargo test
It's a good idea to run clippy and fix any warnings as well:
rustup component add clippy-preview cargo clippy
Finally, run Rustfmt to maintain a common code style:
rustup component add rustfmt-preview cargo fmt
Don‘t forget to update the CHANGELOG.md file and any appropriate documentation. Once you’re finished, push to your fork and submit a pull request. We try to respond to new issues and pull requests quickly, so if there hasn't been any response for more than a few days feel free to ping @bheisler.
Some things that will increase the chance that your pull request is accepted:
Good documentation is one of the core goals of the TinyTemplate project, so new code in pull requests should have clear and complete documentation.
TinyTemplate uses a simple set of labels to track issues. Most important are the difficulty labels:
Additionally, there are a few other noteworthy labels:
We follow the Rust Code of Conduct.