-
Notifications
You must be signed in to change notification settings - Fork 1
/
CONTRIBUTING.md
35 lines (23 loc) · 1.83 KB
/
CONTRIBUTING.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
# Contributing to CONTRIBUTING.md
First off, thanks for taking the time to contribute!
All types of contributions are encouraged and valued. We are still early in the project and there is a lot of work to be done.
> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
> - Star the project
> - Tweet about it
> - Refer this project in your project's readme
> - Mention the project at local meetups and tell your friends/colleagues
## I Want To Contribute
### Security Issues
You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue
tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to [email protected]
### Reporting Bugs
We use GitHub issues to track bugs and errors. If you run into an issue with the project:
- Open an [Issue](/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
- Explain the behavior you would expect and the actual behavior.
- Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
- Provide the information you collected in the previous section.
## Your First Code Contribution
Checkout the roadmap for the project and see if there is something you can help with. If you are new to open source,
You can also reach our to the project team and ask for help. We are happy to help you get started.
## Join The Project Team
Send us an email/telegram/whatsapp and we will get back to you as soon as possible.