You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING_GUIDELINES.md
+25-5Lines changed: 25 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,25 @@
1
-
## Contributing Guidelines
1
+
## Contributing Guidelines🙌
2
2
3
3
This documentation contains a set of guidelines to help you during the contribution process.
4
4
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,
5
5
**no contribution is too small.**
6
6
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
+
7
23
## Steps to Contribute👩💻👨💻
8
24
9
25
Following are the steps to guide you:
@@ -31,25 +47,28 @@ Following are the steps to guide you:
31
47
```
32
48
* 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)
33
49
34
-
##Note:
50
+
51
+
##Note:🔨
35
52
36
53
> - Do not edit/delete someone else's code in this repository. You can only insert new files/folder in this repository.
37
54
38
55
> - 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.
39
56
40
-
## What should I keep in mind while contributing?
57
+
58
+
## What should I keep in mind while contributing?💡
41
59
- When you are contributing, make sure that the work is entirely your own and not from some other source.
42
60
- All the scripts must follow [PEP 8 Style Guidelines](https://www.python.org/dev/peps/pep-0008/).
43
61
44
-
## Resources
45
-
1. Markdown : Markdown is a lightweight markup language like HTML, with plain text formatting syntax.
46
62
63
+
## Resources📖
64
+
1. Markdown : Markdown is a lightweight markup language like HTML, with plain text formatting syntax.
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.
50
68
* [Videos to get started](https://www.youtube.com/watch?v=xAAmje1H9YM&list=PLeo1K3hjS3usJuxZZUBdjAcilgfQHkRzW)
0 commit comments