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
+27-18Lines changed: 27 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,25 +1,11 @@
1
1
## Contributing Guidelines🙌
2
2
3
3
This documentation contains a set of guidelines to help you during the contribution process.
4
+
4
5
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
6
**no contribution is too small.**
6
7
7
8
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
-
23
9
## Steps to Contribute👩💻👨💻
24
10
25
11
Following are the steps to guide you:
@@ -52,12 +38,33 @@ Following are the steps to guide you:
52
38
53
39
> - Do not edit/delete someone else's code in this repository. You can only insert new files/folder in this repository.
54
40
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.
41
+
> - 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.
56
42
57
43
58
44
## What should I keep in mind while contributing?💡
59
-
- When you are contributing, make sure that the work is entirely your own and not from some other source.
60
-
- All the scripts must follow [PEP 8 Style Guidelines](https://www.python.org/dev/peps/pep-0008/).
45
+
46
+
### Coding Style
47
+
48
+
We want your work to be readable by others; therefore, we encourage you to note the following:
49
+
50
+
- Follow PEP8 guidelines. Read more about it <a href="https://pep8.org/"> here. </a>
51
+
- Please write in Python 3.7+. __print()__ is a function in Python 3 so __print "Hello"__ will _not_ work but __print("Hello")__ will.
52
+
- Please focus hard on naming of functions, classes, and variables. Help your reader by using __descriptive names__ that can help you to remove redundant comments.
53
+
- Please follow the [Python Naming Conventions](https://pep8.org/#prescriptive-naming-conventions) so variable_names and function_names should be lower_case, CONSTANTS in UPPERCASE, ClassNames should be CamelCase, etc.
54
+
- Expand acronyms because __gcf()__ is hard to understand but __greatest_common_factor()__ is not.
55
+
56
+
57
+
### Other points to remember while submitting your work:
58
+
59
+
- Create a folder with a meaningful repository name (If Digital Clock is submitted for example, the Folder Name should be "DigitalClock" and the File Name as "digital_clock.py")
60
+
- File extension for code should be `.py`.
61
+
- Strictly use snake_case (underscore_separated) in your file_name, as it will be easy to parse in future using scripts.
62
+
- Please avoid creating new directories if at all possible. Try to fit your work into the existing directory structure you have created for your project. If you want to, please contact before doing so.
63
+
- The README.md file should be concise and clear about what the project is about and what it does.
64
+
- It should be documented briefly enough to let readers understand. Screenshot inclusion is must
65
+
- If you have modified/added code work, make sure the code compiles before submitting.
66
+
- If you have modified/added documentation work, ensure your language is concise and contains no grammar errors.
67
+
- Do not update the [README.md](https://github.com/prathimacode-hub/Awesome_Python_Scripts/blob/main/README.md) and [CONTRIBUTING_GUIDELINES.md](https://github.com/prathimacode-hub/Awesome_Python_Scripts/blob/main/CONTRIBUTING_GUIDELINES.md).
61
68
62
69
63
70
## Resources📖
@@ -80,3 +87,5 @@ You can refer to the following articles on basics of Git and Github and also con
80
87
81
88
## Tip from me😇
82
89
It always takes time to understand and learn. So, do not worry at all. I know **you have got this**!💪
0 commit comments