Pillow/CONTRIBUTING.md

27 lines
1.2 KiB
Markdown
Raw Normal View History

2014-08-04 09:05:32 +04:00
# Contributing
2014-07-27 14:14:28 +04:00
2014-08-04 09:05:32 +04:00
## Fixes, Features and Changes
2014-08-05 13:35:27 +04:00
Send a pull request. We'll generally want documentation and [tests](Tests/README.rst) for new features. Tests or documentation on their own are also welcomed. Feel free to ask questions as an [issue](https://github.com/python-pillow/Pillow/issues/new) or on IRC (irc.freenode.net, #pil)
2014-08-04 09:05:32 +04:00
- Fork the repo
- Make a branch
- Add your changes + Tests
2014-08-04 11:35:07 +04:00
- 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](https://travis-ci.org/profile/) to catch test failures prior to the pull request.
2014-08-04 09:05:32 +04:00
- Push to your fork, and make a pull request.
2014-07-27 14:14:28 +04:00
2014-08-04 09:05:32 +04:00
A few guidelines:
- Try to keep any code commits clean and separate from reformatting commits.
- All new code is going to need tests.
2014-08-04 09:09:04 +04:00
- Try to follow PEP8.
2014-07-27 14:14:28 +04:00
2014-08-04 09:05:32 +04:00
## Bugs
2014-08-05 13:35:27 +04:00
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.
2014-08-04 09:05:32 +04:00
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?