Skip to content

Commit 80632fc

Browse files
authored
Merge pull request #73 from suhanipaliwal/suhanipaliwal-patch-1
Added CONTRIBUTING.md
2 parents 49bbd31 + 5afeb08 commit 80632fc

File tree

1 file changed

+47
-0
lines changed

1 file changed

+47
-0
lines changed

CONTRIBUTING.md

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# **Contributing Guidelines** 📄
2+
3+
This documentation contains a set of guidelines to help you during the contribution process.
4+
We are happy to welcome all the contributions from anyone willing to improve/add new scripts to this project.
5+
Thank you for helping out and remember, **no contribution is too small.**
6+
<br>
7+
Please note we have a [code of conduct](CODE_OF_CONDUCT.md) please follow it in all your interactions with the project.
8+
9+
10+
11+
<br>
12+
13+
## **Need some help regarding the basics?🤔**
14+
15+
16+
You can refer to the following articles on basics of Git and Github and also contact the Project Mentors,
17+
in case you are stuck:
18+
19+
- [Forking a Repo](https://help.github.com/en/github/getting-started-with-github/fork-a-repo)
20+
- [Cloning a Repo](https://help.github.com/en/desktop/contributing-to-projects/creating-an-issue-or-pull-request)
21+
- [How to create a Pull Request](https://opensource.com/article/19/7/create-pull-request-github)
22+
- [Getting started with Git and GitHub](https://towardsdatascience.com/getting-started-with-git-and-github-6fcd0f2d4ac6)
23+
- [Learn GitHub from Scratch](https://docs.github.com/en/get-started/start-your-journey/git-and-github-learning-resources)
24+
25+
<br>
26+
27+
## **Issue Report Process 📌**
28+
29+
1. Go to the project's issues.
30+
2. Give proper description for the issues.
31+
3. Don't spam to get the assignment of the issue 😀.
32+
4. Wait for till someone is looking into it !.
33+
5. Start working on issue only after you got assigned that issue 🚀.
34+
35+
<br>
36+
37+
## **Pull Request Process 🚀**
38+
39+
1. Ensure that you have self reviewed your code 😀
40+
2. Make sure you have added the proper description for the functionality of the code
41+
3. I have commented my code, particularly in hard-to-understand areas.
42+
4. Add screenshot it help in review.
43+
5. Submit your PR by giving the necesarry information in PR template and hang tight we will review it really soon 🚀
44+
45+
<br>
46+
47+
# **Thank you for contributing💗**

0 commit comments

Comments
 (0)