Skip to content

Commit a715cfe

Browse files
authored
docs(contribution): added contribution guidelines
1 parent b26f11a commit a715cfe

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

CONTRIBUTING.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
## Welcome
2+
3+
Thank you. Your contribution is much appreciated in making this a better project for users.
4+
5+
Here is how you can contribute.
6+
7+
### Bug Reporting
8+
9+
If you have found a bug in the project, please do report. Create a new issue and provide
10+
all the information and context regarding the bug. And if you know the fix, please create
11+
a pull request.
12+
13+
### New Feature Request
14+
15+
If you think a new feaure will improve the project's usage, please provide your suggestions.
16+
Create a new issue and outline the feature description and its usage.
17+
If you know how to implement it, please create a pull request with your feature development.
18+
19+
### Pull Requests
20+
21+
To help maintainers understand your contribution, please follow these step for any kind contribution:
22+
23+
- Explain the need of your contribution in a new issue
24+
- If this is a bug fix, please provide a failing test case
25+
- After maintainers agree that it can be a valuable contribution, fork and create a pull request with your changes
26+
- Pull request will be reviewed and merged as soon as possible if following these guidelines
27+

0 commit comments

Comments
 (0)