Skip to content

Contributors Guide

Interested in contributing? Awesome! Before you do though, please read our Code of Conduct. We take it very seriously, and expect that you will as well.

There are many ways you can contribute! ❤️

Bug Reports and Fixes 🐞

  • If you find a bug, please search for it in the issues, and if it isn’t already tracked, create a new issue. Fill out the “Bug Report” section of the issue template. Even if an issue is closed, feel free to comment and add details, it will still be reviewed.
  • Issues that have already been identified as a bug (note: able to reproduce) will be labelled bug.
  • If you’d like to submit a fix for a bug, send a pull request and mention the issue number.
    • Include tests that isolate the bug and verifies that it was fixed.

New Features 💡

  • If you’d like to add new functionality to this project, describe the problem you want to solve in a new issue.
  • Issues that have been identified as a feature request will be labelled enhancement.
  • If you’d like to implement the new feature, please wait for feedback from the project maintainers before spending too much time writing the code. In some cases, enhancements may not align well with the project objectives at the time.

Tests 🔎, Documentation 📚, Miscellaneous ✨

  • If you’d like to improve the tests, you want to make the documentation clearer, you have an alternative implementation of something that may have advantages over the way its currently done, or you have any other change, we would be happy to hear about it!
    • If its a trivial change, go ahead and pull request with the changes you have in mind.
    • If not, open an issue to discuss the idea first.

If you’re new to our project and looking for some way to make your first contribution, look for issues labelled good first contribution.

Requirements

For your contribution to be accepted:

  • [x] You must have signed the Contributor License Agreement (CLA).
  • [x] The test suite must be complete and pass.
  • [x] The changes must be approved by code review.
  • [x] Commits should be atomic and messages must be descriptive. Related issues should be mentioned by issue number.

If the contribution doesn’t meet the above criteria, you may fail our automated checks or a maintainer will discuss it with you. You can continue to improve a Pull Request by adding commits to the branch from which the PR was created.

Interested in knowing more about about pull requests at Slack?

Creating a Pull Request

  1. 🍴 Fork the repository on GitHub.
  2. 🏃‍♀️ Clone/fetch your fork to your local development machine. It’s a good idea to run the tests just to make sure everything is in order.
  3. 🌿 Create a new branch and check it out.
  4. 🔮 Make your changes and commit them locally. Magic happens here!
  5. ⤴️ Push your new branch to your fork. (e.g. git push username fix-issue-16).
  6. 📥 Open a Pull Request on github.com from your new branch on your fork to main in this repository.

Maintainers

There are more details about processes and workflow in the Maintainer’s Guide.