Skip to content

Commit

Permalink
Created Contributing.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Shreyas-Warrier authored Sep 24, 2023
1 parent 8ff3329 commit 8c37045
Showing 1 changed file with 38 additions and 0 deletions.
38 changes: 38 additions & 0 deletions .github/Contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# **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://lab.github.com/githubtraining/introduction-to-github)

<br>


## **Pull Request Process 🚀**

1. Make sure to first review your code before creating a PR 😀
2. Make sure you have added the proper description for the functionality of the code
3. Make sure to add a README file in your repository .
4. Make sure to add an image in the ```images``` for website preview
5. Submit your PR by giving the necesarry information and hang tight while we review it 🚀

<br>

# **Happy Developing 💗**

0 comments on commit 8c37045

Please sign in to comment.