Contribution Guide

• Environment Setup
• Where to start?
• Development Discussion
• Security Vulnerabilities
• Coding Style
• Code of Conduct

Environment Setup

1. Fork the repo from Github
2. Clone into your development machine
3. Run npm install to install the dependencies
4. Run npm run dev to run the app on dev mode
5. Run npm run lint:fix to fix the coding style
6. Push to your branch 🚀
7. Go to your Fork and open a PR 🤩

Where to start?

If you want to start right away, we recommend you to start from the open issues in the Todo state.

You can find them here

They're sorted by priority. So feel free to pick an unassigned one. Drop a comment so we can assign it to you.

WARNING

If you want to work on something which is not listed in the ToDo issues. Please read the below section!

Development Discussion

You may propose new features or improvements of existing behavior in the repository's Discussion Board. If you propose a new feature, please be willing to implement at least some of the code that would be needed to complete the feature.

Informal discussion regarding bugs, new features, and implementation of existing features takes place in the #ideas channel of our Discord server.

WARNING

Please do not refactor any existing code without discussing it with the maintainers first.

Security Vulnerabilities

If you discover a security vulnerability, please email to Saeed Vaziry at [email protected]. All security vulnerabilities will be promptly addressed.

Coding Style

Before proposing any PRs please fix your coding style by running the following command

npm run lint:fix

Code of Conduct

Violations of the code of conduct should be reported to Saeed Vaziry at [email protected].

• Participants should embrace tolerance toward differing opinions.
• It is imperative for participants to use language and exhibit behaviors that avoid personal attacks and demeaning comments.
• When evaluating the statements and actions of others, it is crucial to presume positive intentions.
• Any behavior deemed as reasonably constituting harassment is strictly prohibited.