Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
20 lines (14 loc) · 1.17 KB

CONTRIBUTING.md

File metadata and controls

20 lines (14 loc) · 1.17 KB

Contributing

Any contributions you make are greatly appreciated. If you make a addon and would like to link it please feel free to open a issue or create a PR to add it to the documentation.

How To Contribute

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/YourFeature)
  3. Commit your Changes (git commit -m 'Added your feature')
  4. Push to the Branch (git push origin feature/YourFeature)
  5. Open a Pull Request

By contributing you agree that the code you submit you have a right to use for this project and you agree to your code being licensed as MIT.

Contributing Guidelines

  • Please update tests and documentation along with your pull request. If you are fixing a bug please write a test case to cover the bug you have fixed.
  • It is recommended that you create a GitHub issue with the feature you are working on or if a issue already exists it is a good idea to comment on it to let people know you are working on it.
  • If you use prettier or eslint ignore/disable a line please provide a comment above that line to explain why it is needed / safe to do.
  • Generally we prefer to use interative over recusive programming due to speed.