python-pillow/Pillow
1
1
Fork 0
mirror of https://github.com/python-pillow/Pillow.git synced 2024-11-11 04:07:21 +03:00
Code Issues Packages Projects Releases Wiki Activity
69f81ec089
Pillow/CONTRIBUTING.md
Alex Clark 69f81ec089 Wording [ci skip]
2015-04-04 20:57:53 -04:00

1.6 KiB
Raw Blame History

Contributing to Pillow

Bug fixes, feature additions, tests, documentation and more can be contributed via issues and/or pull requests. All contributions are welcome.

Bug fixes, feature additions, etc.

Please send a pull request to the master branch. Please include 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 Pillow repository.
  • Create a branch from master.
  • Develop bug fixes, features, tests, etc.
  • Run the test suite on both Python 2.x and 3.x. 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.
  • Create a pull request to pull the changes from your branch to the Pillow master.

Guidelines

  • Try to keep any code commits clean and separate from reformatting commits.
  • Provide tests for any newly added code.
  • Follow PEP8.

Reporting Issues

When reporting issues, 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 reproduce.

Provide details

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