The current workflow is the following:
- Fork the repo
- Install the precommit file
- Open an issue to describe your feature request or your bug fix with detailed explanation of what you
- Create a branch based on the develop branch (
git checkout -b <prefix-branchname> develop
) - Make your changes
- Run precommit (black linting, flake8 errors, isort)
- Ensure test coverage is still 100%
- Update documentation accordingly
- Update CHANGELOG.md
- Squash all the changes within a single commit as smuch as possible, and ensure the commit message has the format "FIX
#<issue-number>
- Informative description" - Rebase your branch on
develop
to ensure linear history - Open a merge request against
develop
- Ask for review
- Resolve all discussions
- The PR will be merged as soon as possible
We reserve the right to take over (suppress or modify) PR that do not match the workflow or are abandoned.