Skip to content

Latest commit

 

History

History
18 lines (15 loc) · 1.13 KB

CONTRIBUTING.md

File metadata and controls

18 lines (15 loc) · 1.13 KB
Raw

🎉 Contributing

👍 First of all, thank you for taking the time to contribute!

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Pull Request Process

Before you submit your pull request consider the following guidelines:

  1. Search GitHub for an open or closed Pull Request that relates to your submission. You don't want to duplicate effort.
  2. Create the development environment as described in the documentation. TODO
  3. Make your changes in a new git branch.
  4. Create your patch commit, including appropriate test cases
  5. Run the jest command and ensure all test suites has passed.
  6. Update the documentation (.md files) with relevant details about what has been changed with this Pull Request.
  7. Commit your changes using a descriptive commit message, mentioning the issue number that is being resolved, preceeded by a hash. eg: "Closes #121"
  8. You may merge the Pull Request in once you have the sign-off of one of the reviewers.