Please, go through these steps before you submit a PR.
-
Make sure that your PR is not a duplicate.
-
If not, then make sure that:
a. You have done your changes in a separate branch. Branches MUST have descriptive names that start with either the
fix/
orfeature/
prefixes. Good examples are:fix/signin-issue
orfeature/issue-templates
.b. You have a descriptive commit message with a short title (first line).
c. You have only one commit (if not, squash them into one commit).
d.
python3 -m pytest tests
doesn't throw any error. If it does, fix them first and amend your commit (git commit --amend
). -
After these steps, you're ready to open a pull request.
a. Give a descriptive title to your PR.
b. Describe your changes.
c. Put
closes #XXXX
in your comment to auto-close the issue that your PR fixes (if such).d. Add the corresponding labels to your pull request (ex: feature, improvement, bug...)
IMPORTANT: Please review the CONTRIBUTING.md file for detailed contributing guidelines.
PLEASE REMOVE THIS TEMPLATE BEFORE SUBMITTING