Skip to content
This repository has been archived by the owner on Nov 25, 2022. It is now read-only.

Latest commit

 

History

History
44 lines (33 loc) · 2.83 KB

CONTRIBUTING.md

File metadata and controls

44 lines (33 loc) · 2.83 KB
Raw

Contributing Guidelines

For anyone looking to get involved to this project, we are glad to hear from you. Here are a few types of contributions that we would be interested in hearing about.

  • Bug fixes
    • If you find a bug, please first report it using Github Issues.
    • Issues that have already been identified as a bug will be labelled bug.
    • If you'd like to submit a fix for a bug, send a Pull Request from your own fork and mention the Issue number.
      • Include a test that isolates the bug and verifies that it was fixed.
  • New Features
    • If you'd like to accomplish something in the library that it doesn't already do, describe the problem in a new Github 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 think the test coverage could be improved, the documentation could be clearer, you've got an alternative implementation of something that may have more advantages, or any other change we would still be glad hear about it.
    • If its a trivial change, go ahead and send a Pull Request with the changes you have in mind
    • If not, open a Github Issue to discuss the idea first.

Requirements

For a contribution to be accepted:

  • The test suite must be complete and pass
  • Code must follow existing styling conventions
  • Commit messages must be descriptive. Related issues should be mentioned by number
  • If the contribution includes a change to the dependency list then the yarn.lock file must be updated

If the contribution doesn't meet these criteria, a maintainer will discuss it with you on the Issue. You can still continue to add more commits to the branch you have sent the Pull Request from.

How To

  1. Fork this repository on GitHub.
  2. Clone/fetch your fork to your local development machine.
  3. Create a new branch (e.g. issue-12, feat/add_foo, etc) and check it out.
  4. Make your changes and commit them. (Did the tests pass?)
  5. Push your new branch to your fork. (e.g. git push myname issue-12)
  6. Open a Pull Request from your new branch to the original fork's dev branch.
  7. Ensure the Pull Request's automated status checks have all passed and are ready for review.

Code structure

Source code is to be placed in the src directory and tests in the test directory. Test files should be suffixed with .spec.js and follow a similar test suite structure to existing test files.

All source and test code should follow the same style as existing source and test code and will be enforced by an automated eslint style check that runs on every Pull Request.