Skip to content

Latest commit

 

History

History
149 lines (94 loc) · 4.83 KB

CONTRIBUTING.md

File metadata and controls

149 lines (94 loc) · 4.83 KB
Raw

📝 Contribution Guidline

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and a 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 that 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 Overflow instead.

How Can I Contribute?

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at awesome-python/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-python, in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to ask a question at our Gitter channel.

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 your notes and fixes.

  1. Fork the awesome-python repo on GitHub.
  2. Clone your fork locally:
$ git clone [email protected]:your_username_here/awesome-python.git
  1. Create a branch for adding your notes:
$ git checkout -b name-it-whatever-you-want

Submitting Notes:

Please ensure your pull request adheres to the following guidelines:

  • Search previous suggestions before making a new one, as yours may be a duplicate.
  • Make an individual pull request for each suggestion.
  • Place your note file under the notes folder.
  • Link it in the readme file.

Submitting PyCon Videos:

Please ensure your pull request adheres to the following guidelines:

  • Search previous suggestions before making a new one, as yours may be a duplicate.
  • Make an individual pull request for each suggestion.
  • Use the following format:
| Thumbnail <img src="https://img.youtube.com/vi/<replace_me>/0.jpg" /> | Video
Title <a name="list_order_number"></a> |
[`videos_timestamps_year`][unique_numbre] | `Video Duration` | [`Speaker Slides
Deck`][unique_numbre] | [`Cloud_Provider_link_backup`][unique_numbre] |
  • Link each of the corresponding links at the bottom of the page:
<!-- Links -->
[unique_numbre]: URL
  • Check your spelling and grammar.

Suggesting a book.

  • Search previous suggestions before making a new one, as yours may be a duplicate.
  • Make an individual pull request for each suggestion.
  • Use the following format:
| Book Cover <img src="img_url" width="60px" /> | Book title, Edition.
<a name="books_number_list"></a> | Author | `year of publication` |
[`Publisher`][unique_numbre] | [`Store`][unique_numbre] |
  • Link each of the corresponding links at the bottom of the page:
<!-- Links -->
[unique_numbre]: URL

Commit and push your changes!

  1. Commit your changes and push your branch to GitHub::
$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-note-branch
  1. Submit a pull request through the GitHub website.
  • Make sure that the pull request has a meaningful title.

Thank you for helping us improve!!!