Start by cloning the Tutor repository:
git clone https://github.com/overhangio/tutor.git cd tutor/
pip install -r requirements/dev.txt
Yes, there are very few unit tests for now, but this is probably going to change.
Tutor code formatting is enforced by black. To check whether your code changes conform to formatting standards, run:
And to automatically fix formatting errors, run:
Static error detection is performed by pylint. To detect errors, run:
Generating the documentation¶
pip install -r requirements/docs.txt cd docs/ make html
You can then browse the documentation with:
Releasing a new version¶
Replace “Unreleased” by the version name and date in CHANGELOG.md.
Create a commit with the version changelog.
make release: this will push to the default repo/branch for the current branch.
Contributing to Tutor¶
Third-party contributions to Tutor and its plugins are more than welcome! Just make sure to follow these guidelines:
Outside of obvious bugs, contributions should be discussed first in the official Tutor forums.
Once we agree on a high-level solution, you should open a pull request on the Tutor repository or the corresponding plugin.
Write a good Git commit title and message: explain why you are making this change, what problem you are solving and which solution you adopted. Link to the relevant conversation topics in the forums and describe your use case. We love long, verbose descriptions :)
Make sure that all tests pass by running
make test(see above).
If your PR is in the Tutor core repository, add an item to the CHANGELOG file, in the “Unreleased” section. Use the same format as the other items:
- [TYPE] DESCRIPTION
Where “TYPE” is either “Bugfix”, “Improvement”, “Feature” or “Security”. You should add an explosion emoji (“💥”) before “[TYPE]” if you are making a breaking change.
Happy hacking! ☘️