Skip to content

Commit

Permalink
Create CONTRIBUTING_GUIDELINE.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Durgesh4993 authored Apr 28, 2024
1 parent 778aed5 commit 3d4fbd5
Showing 1 changed file with 48 additions and 0 deletions.
48 changes: 48 additions & 0 deletions .github/CONTRIBUTING_GUIDELINE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# **Contributing Guidelines** 📄

This documentation contains a set of guidelines to help you during the contribution process.
We are happy to welcome all the contributions from anyone willing to improve/add new scripts to this project.
Thank you for helping out and remember, **no contribution is too small.**
<br>
Please note we have a [code of conduct](CODE_OF_CONDUCT.md) please follow it in all your interactions with the project.



<br>

## **Need some help regarding the basics?🤔**


You can refer to the following articles on basics of Git and Github and also contact the Project Mentors,
in case you are stuck:

- [Forking a Repo](https://help.github.com/en/github/getting-started-with-github/fork-a-repo)
- [Cloning a Repo](https://help.github.com/en/desktop/contributing-to-projects/creating-an-issue-or-pull-request)
- [How to create a Pull Request](https://opensource.com/article/19/7/create-pull-request-github)
- [Getting started with Git and GitHub](https://towardsdatascience.com/getting-started-with-git-and-github-6fcd0f2d4ac6)
- [Learn GitHub from Scratch](https://docs.github.com/en/get-started/start-your-journey/git-and-github-learning-resources)

<br>

## **Issue Report Process 📌**

1. Go to the project's issues.
2. Select the template that better fits your issue.
3. Give proper description for the issues.
4. Don't spam to get the assignment of the issue 😀.
5. Wait for till someone is looking into it !.
6. Start working on issue only after you got assigned that issue 🚀.

<br>

## **Pull Request Process 🚀**

1. Ensure that you have self reviewed your code 😀
2. Make sure you have added the proper description for the functionality of the code
3. I have commented my code, particularly in hard-to-understand areas.
4. Add screenshot it help in review.
5. Submit your PR by giving the necesarry information in PR template and hang tight we will review it really soon 🚀

<br>

# **Happy Hacking 💗**

0 comments on commit 3d4fbd5

Please sign in to comment.