Before creating an Issue for features
/bugs
/docs
please follow these steps:
- search existing issues before creating a new issue (has someone raised this already)
- if it doesn't exist create a new issue giving as much context as possible (please select the correct Issue type, for example
bug
orfeature
ordoc
) - comment on the Issue asking for it to be assigned to you (do not tag maintainers as all maintainers receive your comment notifications)
- only start working on this issue (and open a Pull Request) when it has been assigned to you - this will prevent confusion, multiple people working on the same issue and work not being used.
Before working on an existing Issue please follow these steps:
- comment asking for the issue to be assigned to you (do not tag any maintainers as all maintainers receive your comment notifications)
- after the issue is assigned to you, you can start working on it
- reference the Issue in your Pull Request (for example
closes #85
)
Notes:
- only request to be assigned an issue if you know how to work on it
We welcome everyone to review Pull Requests, it is a great way to learn and network.
- use inline comments to explain your suggestions
- use inline suggestions to propose changes
- don't be rude, disrespectful or aggressive