python-pillow/Pillow
1
1
Fork 0
mirror of https://github.com/python-pillow/Pillow.git synced 2025-01-24 16:24:11 +03:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1181 from python-pillow/aclark-contributing-nits

Browse Source 
Aclark contributing nits
This commit is contained in:
Alex Clark 2015-04-04 20:47:09 -04:00
commit f0d84d8e5e
1 changed files with 18 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
CONTRIBUTING.md
View File

@ -1,25 +1,29 @@
# Contributing # Contributing to Pillow
## Fixes, Features and Changes Contributions of bug fixes, feature additions, tests, documentation and more can be made via [issues](https://github.com/python-pillow/Pillow/issues) and/or [pull requests](https://github.com/python-pillow/Pillow/issues).
Send a pull request to the master branch. 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) ## Bug fixes, feature additions, etc.
- Fork the repo Please send a pull request to the master branch. Please include 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)
- Make a branch from master
- Add your changes + Tests - Fork the Pillow repository.
- 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, and [Coveralls](https://coveralls.io/repos/new) to see if the changed code is covered by tests. - Create a branch from master.
- Push to your fork, and make a pull request onto 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](https://travis-ci.org/profile/) to catch test failures prior to the pull request, and [Coveralls](https://coveralls.io/repos/new) 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
A few guidelines:
- Try to keep any code commits clean and separate from reformatting commits. - Try to keep any code commits clean and separate from reformatting commits.
- All new code is going to need tests. - Provide tests for any newly added code.
- Try to follow PEP8. - Follow PEP8.
## Bugs ## Reporting Issues
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. 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
Let us know:
- What did you do? - What did you do?
- What did you expect to happen? - What did you expect to happen?
- What actually happened? - What actually happened?