Skip to content

Latest commit

 

History

History
32 lines (23 loc) · 1.08 KB

CONTRIBUTING.md

File metadata and controls

32 lines (23 loc) · 1.08 KB
Raw

How to contribute

First of all: Thank you for considering contributing to this project!

Before you write a feature or change a design element, please create a GitHub Issue and check in with others. Somebody else is possibly working on it already!

  1. Create a fork, start your work
  2. Test your code properly
  3. Document your code (how it works and what others should use)
  4. (optional): You may add yourself to the 'Contributors' list in README.md
  5. Create a PR on this repository
  6. If you fixed a bug or a feature request, don't forget to mention the 'Issue'
  7. Profit

LICENSE

This project is distributed under the MIT License! By creating a PR with your code it will fall under that license as well, please keep that in mind.

What you should push

  • Bug fixes
  • Feature improvements (please create an 'issue' first so all can share their ideas)
  • Design updates (same as above)
  • Reworks of your code or code of others (please add why you think yours is better)

What you shouldn't push

  • Spelling mistakes --> GitHub Issues
  • Ideas --> GitHub Issues
  • Feature Requests --> GitHub Issues