Skip to content

Commit c5a12a8

Browse files
committed
📝 add contribution guidline!
Signed-off-by: Harmouch101 <eng.mahmoudharmouch@gmail.com>
1 parent 21f8e28 commit c5a12a8

File tree

1 file changed

+94
-0
lines changed

1 file changed

+94
-0
lines changed

CONTRIBUTING.md

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
# :memo: Contribution Guidline
2+
3+
Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
4+
5+
## Agreement
6+
7+
By submitting fixes to this project you agree to allow them to be redistributed under the MIT license, according to the normal forms and usages of the open-source community.
8+
9+
## Introduction
10+
11+
First thing first, i would like to thank you for considering this project. It's people like you that make it such a wonderful place.
12+
13+
Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.
14+
15+
This is an open source project and we love to receive contributions from our community; yes you! There are many ways to contribute, from sharing your python notes, submitting bug reports and feature requests or writing code which can be incorporated into the main project itself.
16+
17+
### I don't want to read this whole thing I just have a question!!!
18+
19+
We are using a gitter channel for support questions. But please be wary that maintaining an open source project can take a lot of time from the maintainers. If asking for a support question, state it clearly and take the time to explain your problem properly. Also, if your problem is not strictly related to this project, we recommend you to use Stack Overlow instead.
20+
21+
## How Can I Contribute?
22+
23+
You can contribute in many ways:
24+
25+
### Types of Contributions
26+
27+
#### Report Bugs
28+
29+
Report bugs at [awesome-pycon-notes/issues](https://github.com/Harmouch101/awesome-pycon-notes/issues).
30+
31+
If you are reporting a bug, please include:
32+
33+
* Your operating system name and version.
34+
* Any details about your local setup that might be helpful in troubleshooting.
35+
* Detailed steps to reproduce the bug.
36+
37+
#### Fix Bugs
38+
39+
Look through the GitHub issues for bugs. Anything tagged with "bug" and "help
40+
wanted" is open to whoever wants to implement it.
41+
42+
#### Implement Features
43+
44+
Look through the GitHub issues for features. Anything tagged with "enhancement"
45+
and "help wanted" is open to whoever wants to implement it.
46+
47+
#### Share your Notes
48+
49+
This project could always use more notes, whether as part of the
50+
official awesome-pycon-notes, in blog posts, articles, and such.
51+
52+
53+
#### Submit Feedback
54+
55+
The best way to send feedback is to ask a question at [our gitter channel](fix me pleasse).
56+
57+
If you are willing to share notes:
58+
59+
* Add your notes under the notes folder.
60+
* Remember that this is a volunteer-driven project, and that contributions
61+
are welcome :)
62+
63+
## Get Started!
64+
65+
Ready to contribute? Here's how to share you notes and fixes.
66+
67+
1. Fork the `awesome-pycon-notes` repo on GitHub.
68+
2. Clone your fork locally:
69+
70+
```bash
71+
$ git clone git@github.com:your_username_here/awesome-pycon-notes.git
72+
```
73+
74+
3. Create a branch for adding your notes:
75+
76+
```bash
77+
$ git checkout -b name-it-whatever-you-want
78+
```
79+
80+
4. Commit your changes and push your branch to GitHub::
81+
82+
```bash
83+
$ git add .
84+
$ git commit -m "Your detailed description of your changes."
85+
$ git push origin name-of-your-note-branch
86+
```
87+
88+
5. Submit a pull request through the GitHub website.
89+
90+
## Request Guidelines
91+
92+
Just submit a pull request.
93+
94+
Thank you for helping us improve!!!

0 commit comments

Comments
 (0)