Skip to content
This repository has been archived by the owner on Dec 20, 2021. It is now read-only.

Latest commit

 

History

History
29 lines (22 loc) · 1.51 KB

CONTRIBUTING.md

File metadata and controls

29 lines (22 loc) · 1.51 KB

Contribution Guidelines

First of all, thanks for thinking of contributing to this project!

❤ Ways to Contribute

  • Blog or tweet about the project
  • Fix a bug
  • Implement a new feature
  • Discuss potential ways to improve project
  • Improve existing documentation.
  • Improve existing implementation, performance, etc.

There is a code of conduct, the TL:DR is "be nice".

Questions

Feel free to open an issue with your question. Please put some effort in requesting a new feature. If someone else is going to implement something, the least you can do is describe the feature in detail, and why it would be useful to others as well.

Bugs

In case you've encountered a bug, please create an issue. In your issue description, please include:

  • What you expected to see and what happened instead.
  • Your operating system and other environment information.
  • As much information as possible.
  • Steps to reproduce the issue.

Pull Requests

Pull requests are welcome! Please keep the following in mind:

  • Remember that this project is cross-platform compatible (macOS, Windows, Linux, Android, iOS).

Unsure about whether you should open a pull request? Feel free to discuss it first in an issue.