Skip to content

Latest commit

 

History

History
48 lines (32 loc) · 2.25 KB

CONTRIBUTING.md

File metadata and controls

48 lines (32 loc) · 2.25 KB

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

  • Before jumping into a PR be sure to search existing PRs or issues for an open or closed item that relates to your submission.

Issues

Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.

If there isn't an issue for what you want to report, please open a new issue with as much detail as possible about the problem. This includes:

  • A clear and descriptive title
  • A description of the problem, including any error messages
  • Steps to reproduce the problem
  • The expected behavior
  • Screenshots or other relevant information

Developing

The development branch is master. This is the branch that all pull requests should be made against. The changes on the master branch are tagged into a release monthly.

To develop locally:

  1. Fork this repository to your own GitHub account and then clone it to your local device.

  2. Create a new branch:

    git checkout -b MY_BRANCH_NAME
  3. Make your changes.

Please be sure that you can make a full production build before pushing code.

Making a Pull Request


Thank you for your contributions!