1. Contributor checklist
This is a condensed checklist that summarises the information presented in the rest of this guideline.
Before opening your Pull Request, please make sure to:
- Run invoke check tasks locally. This task calls several lint and test scripts and it is the very task that is run by the GitHub CI process.
- A contribution that contains changes to the StrictDoc's codebase shall also include tests that exercise the changed behavior. A contribution without any tests is unlikely to be accepted (with the exception of "code climate" changes, see Python code below).
- Follow the conventions of the section "Git workflow" (see Git workflow). A clean Git history and conventional commit names are expected for every single contribution.