Skip to content

Commit d4e83ff

Browse files
Updated Contributing Guidelines
1 parent cbaee6b commit d4e83ff

File tree

1 file changed

+25
-5
lines changed

1 file changed

+25
-5
lines changed

CONTRIBUTING_GUIDELINES.md

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,25 @@
1-
## Contributing Guidelines
1+
## Contributing Guidelines🙌
22

33
This documentation contains a set of guidelines to help you during the contribution process.
44
I'm happy to welcome all the contributions from anyone willing to add new scripts to this repository. Thank you for helping out and remember,
55
**no contribution is too small.**
66

7+
8+
## Template✔
9+
10+
Before starting your contribution, kindly go through this template that needs to be followed for merging your PR successfully.
11+
12+
- Create a folder with a meaningful repository name (If it's a hello world program, repository should look something like "HelloWorld" and file name as Hello_World.py)
13+
14+
- Repository should include a File_Name.py, README.md and other related files (if any)
15+
16+
- If there are any requirements or pre-requisites needed, do state them in requirements.txt file
17+
18+
- The README.md file should be concise and clear about what the project is about and what it does
19+
20+
- It should be documented briefly enough to let readers understand. Screenshot inclusion is must
21+
22+
723
## Steps to Contribute👩‍💻👨‍💻
824

925
Following are the steps to guide you:
@@ -31,25 +47,28 @@ Following are the steps to guide you:
3147
```
3248
* Step 7: Create a PR on Github. (Don't just hit the create a pull request button, you must write a PR message to clarify why and what are you contributing)
3349
34-
##Note:
50+
51+
##Note:🔨
3552
3653
> - Do not edit/delete someone else's code in this repository. You can only insert new files/folder in this repository.
3754
3855
> - Give a meaningful name to whatever file or folder you are adding, for e.g., if you have written a Python code on hello world, then hello_world.py is one example of valid name.
3956
40-
## What should I keep in mind while contributing?
57+
58+
## What should I keep in mind while contributing?💡
4159
- When you are contributing, make sure that the work is entirely your own and not from some other source.
4260
- All the scripts must follow [PEP 8 Style Guidelines](https://www.python.org/dev/peps/pep-0008/).
4361
44-
## Resources
45-
1. Markdown : Markdown is a lightweight markup language like HTML, with plain text formatting syntax.
4662
63+
## Resources📖
64+
1. Markdown : Markdown is a lightweight markup language like HTML, with plain text formatting syntax.
4765
* [Markdown Cheat-Sheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet)
4866
4967
2. Git : Git is a distributed version-control system for tracking changes in source code during software development. It is designed for coordinating work among programmers, but it can be used to track changes in any set of files.
5068
* [Videos to get started](https://www.youtube.com/watch?v=xAAmje1H9YM&list=PLeo1K3hjS3usJuxZZUBdjAcilgfQHkRzW)
5169
* [Cheat Sheet](https://www.atlassian.com/git/tutorials/atlassian-git-cheatsheet)
5270
71+
5372
## Need more help?🤔
5473
You can refer to the following articles on basics of Git and Github and also contact me, in case you are stuck:
5574
- [Forking a Repo](https://help.github.com/en/github/getting-started-with-github/fork-a-repo)
@@ -58,5 +77,6 @@ You can refer to the following articles on basics of Git and Github and also con
5877
- [Getting started with Git and GitHub](https://towardsdatascience.com/getting-started-with-git-and-github-6fcd0f2d4ac6)
5978
- [Learn GitHub from Scratch](https://lab.github.com/githubtraining/introduction-to-github)
6079
80+
6181
## Tip from me😇
6282
It always takes time to understand and learn. So, do not worry at all. I know **you have got this**!💪

0 commit comments

Comments
 (0)