Pillow/.github/CONTRIBUTING.md

# Contributing to Pillow

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.

## Bug fixes, feature additions, etc.

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

- Fork the Pillow repository.
- Create a branch from master.
- Develop bug fixes, features, tests, etc.
- Run the test suite on Python 2.7 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.
- 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 and AppVeyor.

## 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?

## 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.
Add intro [ci skip] 2015-04-05 03:36:53 +03:00			`# Contributing to Pillow`

Fixed URL [ci skip] 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.`
Add CONTRIBUTING.md [CI skip] 2014-07-27 14:14:28 +04:00
Wording, headers [ci skip] 2015-04-05 03:45:47 +03:00			`## Bug fixes, feature additions, etc.`
Update contributing.md [ci skip] 2014-08-04 09:05:32 +04:00
Corrected link [ci skip] 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`
Update contributing.md [ci skip] 2014-08-04 09:05:32 +04:00
Wording, headers [ci skip] 2015-04-05 03:45:47 +03:00			`- Fork the Pillow repository.`
			`- Create a branch from master.`
			`- Develop bug fixes, features, tests, etc.`
Changed documentation references to 2.x to 2.7 [ci skip] 2018-01-02 04:51:54 +03:00			`- Run the test suite on Python 2.7 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.`
Wording, headers [ci skip] 2015-04-05 03:45:47 +03:00			`- Create a pull request to pull the changes from your branch to the Pillow master.`

			`### Guidelines`
Add CONTRIBUTING.md [CI skip] 2014-07-27 14:14:28 +04:00
Wording [ci skip] 2015-04-05 13:59:09 +03:00			`- Separate code commits from reformatting commits.`
Wording, headers [ci skip] 2015-04-05 03:45:47 +03:00			`- Provide tests for any newly added code.`
			`- Follow PEP8.`
Added AppVeyor to CONTRIBUTING [ci skip] 2016-04-03 14:57:40 +03:00			`- When committing only documentation changes please include [ci skip] in the commit message to avoid running tests on Travis-CI and AppVeyor.`
Wording, headers [ci skip] 2015-04-05 03:45:47 +03:00
			`## Reporting Issues`
Add CONTRIBUTING.md [CI skip] 2014-07-27 14:14:28 +04:00
Wording [ci skip] 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.`
Update contributing.md [ci skip] 2014-08-04 09:05:32 +04:00
Wording, headers [ci skip] 2015-04-05 03:45:47 +03:00			`### Provide details`
Update contributing.md [ci skip] 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?`
How to report security vulnerabilites See https://github.com/python-pillow/Pillow/issues/1658 [CI skip] 2016-02-04 15:19:59 +03:00
			`## Security vulnerabilities`

Update security email address Re: https://github.com/python-pillow/Pillow/issues/1713#issuecomment-204597429 [CI skip] 2016-09-06 21:10:22 +03:00			`To report sensitive vulnerability information, email security@python-pillow.org.`
How to report security vulnerabilites See https://github.com/python-pillow/Pillow/issues/1658 [CI skip] 2016-02-04 15:19:59 +03:00
			`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.`