When contributing to this repository, first discuss the change you wish to make via issues, if the change is large enough to warrant such discussion.
Please follow our Code of Conduct in all your interactions with the project.
- Fork the repository
- Clone your fork
- Create a branch by running
git checkout -b <branch-name> - Write code!
- If you get things working, add your changed files with
git addand then commit them withgit commit - Push your changes to your fork with
git push origin <branch-name> - Create a pull request
- Iterate on the solution
- Get merged! 🎉 🎊
- Use the present tense ("Add feature" not "Added feature")
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
All Python code is formatted with Black.
- Cut off lines at 100 characters
- Indent with 4 spaces
- You can run
black .in the root of the project to format everything for you.
- Indent with 2 spaces
- Indent Jinja template blocks (like
{% if ... %}as well).