Skip to content

Latest commit

 

History

History
56 lines (39 loc) · 3.54 KB

CONTRIBUTING.md

File metadata and controls

56 lines (39 loc) · 3.54 KB
Raw

Contributing Guide

Contributing Guide

🎥 You can watch the video that Eddie created as a contributing guide. Click on the image to watch the video.

Issues & Pull Requests

Creating an Issue

Before creating an Issue for features/bugs/improvements please follow these steps:

  1. search existing Issues before creating a new issue (has someone raised this already)
  2. if it doesn't exist create a new issue giving as much context as possible (please select the correct Issue type, for example bug or feature)
  3. all Issues are automatically given the label status: waiting for triage and are automatically locked so no comments can be made
  4. 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

Working on an Issue (get it assigned to you)

Before working on an existing Issue please follow these steps:

  1. only ask to be assigned 1 open issue at a time
  2. look out for the Issue label status: ready for dev (if it does not have this label, your work might not be accepted)
  3. comment asking for the issue to be assigned to you (do not tag maintainers on GitHub or Discord as all maintainers receive your comment notifications)
  4. after the Issue is assigned to you, you can start working on it
  5. 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
  6. do not enable GitHub Actions on your fork
  7. reference the Issue in your Pull Request (for example closes #123)
  8. please do not force push to your PR branch, this makes it very difficult to re-review - commits will be squashed when merged

Notes:

  • it is not sustainable for maintainers to review historical comments asking for assignments before the Issue label status: ready for dev was added; only requests for assignment of an Issue after this label has been added will be considered
  • 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

Reviewing Pull Requests

We welcome everyone to review Pull Requests, it is a great way to learn, network and support each other.

DOs

  • be kind and respectful, we use inclusive, gender neutral language (for example they/them instead of guy/man)
  • use inline comments to explain your suggestions
  • use inline suggestions to propose changes

DON'Ts

  • 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 contributors graph

Note: Persistent non-compliance with this Contributing Guide can lead to a warning and/or ban under the Code of Conduct