Skip to content

Latest commit

 

History

History
41 lines (30 loc) · 1.63 KB

CONTRIBUTING.md

File metadata and controls

41 lines (30 loc) · 1.63 KB
Raw

Contributing

Star ⭐

The easiest way to show your support is by starring the repository

Reporting Bugs

  • Check the FAQ.
  • Check if an issue has already been reported. If so, comment on it and provide further info if any.
  • Follow the Bug Report issue template and provide relevant information.

Get in touch

You can chat with us on Gitter.

Contributing Code

  • Make sure to follow the code style followed throughout the project.
  • If you add a new dependency, make sure it is compatible with MIT license. e.g. GPL is not compatible with MIT license. Also, add the license file to the licenses folder.
  • If you want to add a new feature, discuss it first by opening an issue on GitHub whether it aligns with the goals of the project.
  • If possible, write tests.

Translation

Don't send pull-requests for translation. Use Crowdin instead.

If you want to add a new language, open a discussion on the Crowdin project or a new issue here on GitHub to let me know.

Testing

A lot of help is needed in this area. Writing tests or just manually testing and reporting or fixing the issues found would be a great help.

Website

The website in written in Angular and resides in a separate repository.

Donation 💲

You can donate on PayPal.

You can see the list of donations on the website.

Spread the word

Recommend to others, write reviews, etc.