Skip to content

Latest commit

 

History

History
80 lines (49 loc) · 3.33 KB

CONTRIBUTING.md

File metadata and controls

80 lines (49 loc) · 3.33 KB
Raw

Contributing

Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.

We accept pull requests for bug fixes and small features where the approach will be simple and straightforward. We'd also love to hear about ideas for new features as issues.

We track issues on our project board here.

Please do:

  • Check existing issues to verify that the bug or feature request has not already been submitted.
  • Open an issue if things aren't working as expected.
  • Open an issue to propose a significant change.
  • Open a pull request to fix a bug.
  • If you're contributing for the first time here, try and look for any issues labelled good first issue.

Please avoid:

  • Opening pull requests for issues marked Status: Design Needed, Status: To Be Discussed, or Status: Need Exploration.
  • Keeping issues assigned to yourself for long: If you've been assigned an issue, please be mindful that if there's no PR/activity in a week's time, you'll be unassigned.


Instructions to set up the code

Please check our README section to find detailed instructions about the code setup, as well as running and testing the code locally.



Submitting a pull request

  1. Make the changes in your code locally. Check setup instructions here.
  2. Create a new branch: git checkout -b your-branch-name
  3. Make your code changes, add tests (if required), and make sure the existing tests and builds still pass locally.
  4. Push to your fork and submit a pull request.
  5. One you submit a pull request, you will receive an automated reply from the CLA bot asking you to sign a Contributor License Agreement.
    • Once signed, please allow some time (~1 day) for the team to authorize your CLA check.
    • Read more about a CLA Agreement here.

Here are a few things you can do that will increase the likelihood of your pull request being accepted:

  • Format your code with prettier.
  • Write tests when needed.
  • Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
  • Write a good commit message.


Open Source

Contributions to this project are released to the public under the project's open source license.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.



Resources