Before creating an Issue for features
/bugs
/improvements
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
- All issues are automatically given the label
status: waiting for triage
and are automatically locked so no comments can be made - If you wish to work on the Issue once it has been triaged and label changed to
status: ready for dev
, please include this in your Issue description
Before working on an existing Issue please follow these steps:
- Only ask to be assigned 1 open issue at a time
- Look out for the Issue label
status: ready for dev
- Comment asking for the issue to be assigned to you.
- After the Issue is assigned to you, you can start working on it
- 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
- reference the Issue in your Pull Request (for example
closes #123
)
- check the
Assignees
box at the top of the page to see if the issue has been assigned to someone else before requesting this be assigned to you - if an Issue is unclear, ask questions to get more clarity before asking to have the Issue assigned to you
- only request to be assigned an Issue if you know how to work on it
- an Issue can be assigned to multiple people if you all agree to collaborate on the issue (the Pull Request can contain commits from different collaborators)
- any Issues that have no activity after 2 weeks will be unassigned and re-assigned to someone else
We welcome everyone to review Pull Requests, it is a great way to learn, network, and support each other.
- be kind and respectful
- use inline comments to explain your suggestions
- use inline suggestions to propose changes
- do not be rude, disrespectful, or aggressive
- do not repeat feedback, this creates more noise than value (check the existing conversation), use GitHub reactions if you agree/disagree with a comment
- do not blindly approve pull requests to improve your GitHub contributor's graph