python-pillow/Pillow
1
1
Fork 0
mirror of https://github.com/python-pillow/Pillow.git synced 2024-12-26 01:46:18 +03:00
Code Issues Packages Projects Releases Wiki Activity
d328b48320
Pillow/CONTRIBUTING.md
Hugo a2a9bd8e04 Mention Coveralls 
[CI skip]
2014-09-17 20:24:34 +03:00

1.3 KiB
Raw Blame History

Contributing

Fixes, Features and Changes

Send a pull request. We'll generally want documentation and tests for new features. Tests or documentation on their own are also welcomed. Feel free to ask questions as an issue or on IRC (irc.freenode.net, #pil)

  • Fork the repo
  • Make a branch
  • Add your changes + Tests
  • Run the test suite. Try to run on both Python 2.x and 3.x, or you'll get tripped up. You can enable Travis CI on your repo to catch test failures prior to the pull request, and Coveralls to see if the changed code is covered by tests.
  • Push to your fork, and make a pull request.

A few guidelines:

  • Try to keep any code commits clean and separate from reformatting commits.
  • All new code is going to need tests.
  • Try to follow PEP8.

Bugs

When reporting bugs, please include example code that reproduces the issue, and if possible a problem image. 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 Pillow and Python are you using?