python-pillow/Pillow
1
1
Fork 0
mirror of https://github.com/python-pillow/Pillow.git synced 2024-12-26 09:56:17 +03:00
Code Issues Packages Projects Releases Wiki Activity
8fd37070af
Pillow/CONTRIBUTING.md
Andrew Murray 672dce15fb Changed CONTRIBUTING documentation [ci skip]
2015-10-26 21:57:28 +11:00

1.7 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 without bug fixes or feature additions are welcome too. Feel free to ask questions via issues or 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

  • Separate code commits from reformatting commits.
  • Provide tests for any newly added code.
  • Follow PEP8.
  • When committing only documentation changes please include [ci skip] in the commit message to avoid running tests on Travis-CI.

Reporting Issues

When reporting issues, please include code that reproduces the issue and whenever possible, an image that demonstrates the issue. The best reproductions are self-contained scripts with minimal dependencies.

Provide details

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