Skip to content

Latest commit

 

History

History
60 lines (37 loc) · 2.48 KB

CONTRIBUTING.md

File metadata and controls

60 lines (37 loc) · 2.48 KB
Raw

How To Contribute

Every open source project lives from the generous help by contributors that sacrifice their time and PyMediaRSS2Gen is no different.

  • No contribution is too small; please submit as many fixes for typos and grammar bloopers as you can!
  • If you have any questions, feel free to ask them as an issue.

To make participation as pleasant as possible, this project adheres to the Code of Conduct by the Python Software Foundation.

Bugs

When reporting bugs, please include example code that reproduces the issue. The best reproductions are self-contained scripts that pull in as few dependencies as possible. An entire Django stack is harder to handle.

Let us know:

  • What did you do?
  • What did you expect to happen?
  • What actually happened?
  • What versions of PyMediaRSS2Gen and Python are you using?

Fixes, Features and Changes

This project lives on GitHub. You are very welcome to send a pull request!

By contributing your code, you agree to license your contribution under the MIT license.

How to contribute:

  • Fork the repo
  • Make a branch
  • Add your changes
  • Check if the code is working on Python versions 2.6, 2.7 and 3.4.
    (Automated testing with tox is still a Todo)
  • Push to your fork, and make a pull request.

A few guidelines to get you started:

  • This is ALPHA, still try to avoid breaking backwards compatibility.
  • Follow PEP 8 and PEP 257 (See flake8 and flake8-docstrings).
  • Add yourself to the AUTHORS.rst file in an alphabetical fashion.
    Every contribution is valuable and shall be credited.
  • If your change is noteworthy, add an entry to the CHANGELOG.rst file, add the issue number if applicable.
  • Keep code commits clean and separate from reformatting commits
  • Ideally, squash your code commits.
  • Write good commit messages.

Thank you for considering to contribute to PyMediaRSS2Gen!