Skip to content

Commit

Permalink
📝 add contribution guidline!
Browse files Browse the repository at this point in the history
Signed-off-by: Harmouch101 <[email protected]>
  • Loading branch information
wiseaidev committed Feb 27, 2022
1 parent 21f8e28 commit c5a12a8
Showing 1 changed file with 94 additions and 0 deletions.
94 changes: 94 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
# :memo: Contribution Guidline

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

## Agreement

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.

## Introduction

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.

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.

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.

### I don't want to read this whole thing I just have a question!!!

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.

## How Can I Contribute?

You can contribute in many ways:

### Types of Contributions

#### Report Bugs

Report bugs at [awesome-pycon-notes/issues](https://github.com/Harmouch101/awesome-pycon-notes/issues).

If you are reporting a bug, please include:

* Your operating system name and version.
* Any details about your local setup that might be helpful in troubleshooting.
* Detailed steps to reproduce the bug.

#### Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with "bug" and "help
wanted" is open to whoever wants to implement it.

#### Implement Features

Look through the GitHub issues for features. Anything tagged with "enhancement"
and "help wanted" is open to whoever wants to implement it.

#### Share your Notes

This project could always use more notes, whether as part of the
official awesome-pycon-notes, in blog posts, articles, and such.


#### Submit Feedback

The best way to send feedback is to ask a question at [our gitter channel](fix me pleasse).

If you are willing to share notes:

* Add your notes under the notes folder.
* Remember that this is a volunteer-driven project, and that contributions
are welcome :)

## Get Started!

Ready to contribute? Here's how to share you notes and fixes.

1. Fork the `awesome-pycon-notes` repo on GitHub.
2. Clone your fork locally:

```bash
$ git clone [email protected]:your_username_here/awesome-pycon-notes.git
```

3. Create a branch for adding your notes:

```bash
$ git checkout -b name-it-whatever-you-want
```

4. Commit your changes and push your branch to GitHub::

```bash
$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-note-branch
```

5. Submit a pull request through the GitHub website.

## Request Guidelines

Just submit a pull request.

Thank you for helping us improve!!!

0 comments on commit c5a12a8

Please sign in to comment.