Skip to content
Petri Savolainen edited this page Jul 4, 2015 · 3 revisions

Contributing

This is a pretty standard open-source project. Contributions are always welcome and desired. A few guidelines/requests for contributors are outlined below.

Code

If you would like to contribute code to this project, please preferably do so in the form of a github pull request, or if not possible, as a unified or git diff that can be applied to the git trunk.

Please:

  • roughly follow PEP 8
  • be willing to run the tests before submitting a pull request
  • be willing to explain your code when asked

Bugs/Feature requests

  • Please use the github issue tracker for this project
  • If possible include the generated error, and how to reproduce it
  • For feature requests, we will most likely ask questions, make comments, etc to the github issue itself, so please keep an eye on it.

Documentation

Edit away, or send documentation via email and the appropriate page will be added/edited

Other

If there are other ways of contributing that should be mentioned here, let us know

Licensing

Currently pybeanstalk is listed as a GPL v3 project. This will most likely be changed to a dual licensing, GPL v3 and BSD scheme in the near future. Contributing code to this project for inclusion implies that you agree with this decision.

Clone this wiki locally