The easiest way to contribute is to report issues or bugs that you might
find while using template-workshop. You can do this by creating a
new
issue on our GitHub repository.
If you would like to contribute content, please check out our guide for more specific details on how we work and develop. It is a regularly evolving document, so is at various states of completion.
To contribute to template-workshop, you first need to install
uv and
justfile. We use uv and
justfile to manage our project, such as to run checks and test the
template. Both the uv and justfile websites have a more detailed guide
on using uv, but below are some simple instructions to get you started.
It's easiest to install uv and justfile using pipx, so you should install that first. Then, to install uv and justfile, run:
pipx install uv rust-justWe keep all our development workflows in the justfile, so you can
explore it to see what commands are available. To see a list of commands
available, run:
justAs you contribute, make sure your changes will pass our tests by opening
a terminal so that the working directory is the root of this project
(template-workshop/) and running:
just run-allWhen testing the template, copier can only use content kept in the Git history. Meaning that if you make changes to the template and try to test it, it won't be able to test those changes. You have to commit the changes first in order for copier to use them.
When committing changes, please try to follow Conventional Commits as Git messages. Using this convention allows us to be able to automatically create a release based on the commit message by using Commitizen. If you don't use Conventional Commits when making a commit, we will revise the pull request title to follow that format, as we use squash merges when merging pull requests, so all other commits in the pull request will be squashed into one commit.