🚨 We'll only merge PRs which follow the folowing requirements, but you can open it anytime you want
Checkout the first PR using this guideline for clarrification.
- Have concise title e.g.
Add continous integration - Compare from a branch other than your master
- Have the last release as their base
- Use at least one of the labels bellow, ignore this item if source files were not touched
- bug for fixing bugs, errors and miss behaviours
- feature request for issues not marked on the roadmap
- release for issues related to the "product release"
- Use the label docs when PR contains typo-fixings, rephrasings which improve documental understanding and changes on the ubiquitous language
If your only label is "docs", skip this "Proposed changes" all together.
Brief about your changes. Why is it effective? Which alternatives have you considered?
- Closes short description replace NUMBER by your issue number when appropriate
- Relates to short description replace NUMBER by your issue number when appropriate
- Implements the idea described on short description, but using an alternative approach
- ...
Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.
github even allow you to (un)check them on the PR
- I have reviewed the most recent version of CONTRIBUTING to this repository
- I have validated that lint and tests pass locally with my changes
- I have added tests that prove the PR works (if appropriate)
- I have covered at least 50% of the code
- I have added necessary documentation (if appropriate)
- I have merged the last version into my PR (if appropriate)
- I have reviewed the PR and consider it to be small (to make reviewing it easier)