Pillow/.github/CONTRIBUTING.md

38 lines
2.1 KiB
Markdown
Raw Normal View History

2015-04-05 03:36:53 +03:00
# Contributing to Pillow
2016-01-21 14:28:30 +03:00
Bug fixes, feature additions, tests, documentation and more can be contributed via [issues](https://github.com/python-pillow/Pillow/issues) and/or [pull requests](https://github.com/python-pillow/Pillow/pulls). All contributions are welcome.
2014-07-27 14:14:28 +04:00
2015-04-05 03:45:47 +03:00
## Bug fixes, feature additions, etc.
2014-08-04 09:05:32 +04:00
2016-04-29 11:48:20 +03:00
Please send a pull request to the master branch. Please include [documentation](https://pillow.readthedocs.io) and [tests](../Tests/README.rst) for new features. Tests or documentation without bug fixes or feature additions are welcome too. Feel free to ask questions [via issues](https://github.com/python-pillow/Pillow/issues/new) or irc://irc.freenode.net#pil
2014-08-04 09:05:32 +04:00
2015-04-05 03:45:47 +03:00
- 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](https://travis-ci.org/profile/) and [AppVeyor](https://ci.appveyor.com/projects/new) on your repo 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.
2015-04-05 03:45:47 +03:00
- Create a pull request to pull the changes from your branch to the Pillow master.
### Guidelines
2014-07-27 14:14:28 +04:00
2015-04-05 13:59:09 +03:00
- Separate code commits from reformatting commits.
2015-04-05 03:45:47 +03:00
- 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 and AppVeyor.
2015-04-05 03:45:47 +03:00
## Reporting Issues
2014-07-27 14:14:28 +04:00
2015-04-05 14:01:33 +03:00
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.
2014-08-04 09:05:32 +04:00
2015-04-05 03:45:47 +03:00
### Provide details
2014-08-04 09:05:32 +04:00
- What did you do?
- What did you expect to happen?
- What actually happened?
- What versions of Pillow and Python are you using?
## Security vulnerabilities
To report sensitive vulnerability information, email security@python-pillow.org.
If your organisation/employer is a distributor of Pillow and would like advance notification of security-related bugs, please let us know your preferred contact method.