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 `main` 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), [discussions](https://github.com/python-pillow/Pillow/discussions/new), [Gitter](https://gitter.im/python-pillow/Pillow) or irc://irc.freenode.net#pil

- Fork the Pillow repository.
- Create a branch from `main`.
- Develop bug fixes, features, tests, etc.
- Run the test suite. You can enable GitHub Actions (https://github.com/MY-USERNAME/Pillow/actions) and [AppVeyor](https://ci.appveyor.com/projects/new) on your repo to catch test failures prior to the pull request, and [Codecov](https://codecov.io/gh) to see if the changed code is covered by tests.
- Create a pull request to pull the changes from your branch to the Pillow `main`.

### Guidelines

- Separate code commits from reformatting commits.
- Provide tests for any newly added code.
- Follow PEP 8.
- When committing only documentation changes please include `[ci skip]` in the commit message to avoid running tests on AppVeyor.
- Include [release notes](https://github.com/python-pillow/Pillow/tree/main/docs/releasenotes) as needed or appropriate with your bug fixes, feature additions and tests.

## Reporting Issues

When reporting issues, please include code that reproduces the issue and whenever possible, an image that demonstrates the issue. Please upload images to GitHub, not to third-party file hosting sites. If necessary, add the image to a zip or tar archive.

The best reproductions are self-contained scripts with minimal dependencies. If you are using a framework such as plone, Django, or buildout, try to replicate the issue just using Pillow.

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

Please see our [security policy](https://github.com/python-pillow/Pillow/blob/main/.github/SECURITY.md).
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
Link to GitHub discussions [ci skip] 2022-05-25 15:14:29 +03:00			Please send a pull request to the `main` 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), [discussions](https://github.com/python-pillow/Pillow/discussions/new), [Gitter](https://gitter.im/python-pillow/Pillow) 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.`
Rename master to main 2021-10-15 17:30:05 +03:00			- Create a branch from `main`.
Wording, headers [ci skip] 2015-04-05 03:45:47 +03:00			`- Develop bug fixes, features, tests, etc.`
Show example link instead of hiding inside hyperlink Co-authored-by: Andrew Murray <3112309+radarhere@users.noreply.github.com> 2020-12-18 13:37:24 +03:00			`- Run the test suite. You can enable GitHub Actions (https://github.com/MY-USERNAME/Pillow/actions) and [AppVeyor](https://ci.appveyor.com/projects/new) on your repo to catch test failures prior to the pull request, and [Codecov](https://codecov.io/gh) to see if the changed code is covered by tests.`
Rename master to main 2021-10-15 17:30:05 +03:00			- Create a pull request to pull the changes from your branch to the Pillow `main`.
Wording, headers [ci skip] 2015-04-05 03:45:47 +03:00
			`### 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.`
Drop support for EOL Python 2.7 2019-09-26 15:12:28 +03:00			`- Follow PEP 8.`
Remove old Travis CI config 2020-12-14 21:35:04 +03:00			- When committing only documentation changes please include `[ci skip]` in the commit message to avoid running tests on AppVeyor.
Rename master to main 2021-10-15 17:30:05 +03:00			`- Include [release notes](https://github.com/python-pillow/Pillow/tree/main/docs/releasenotes) as needed or appropriate with your bug fixes, feature additions and tests.`
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
Include further instructions from ISSUE_TEMPLATE [ci skip] 2018-07-21 13:40:13 +03:00			`When reporting issues, please include code that reproduces the issue and whenever possible, an image that demonstrates the issue. Please upload images to GitHub, not to third-party file hosting sites. If necessary, add the image to a zip or tar archive.`

			`The best reproductions are self-contained scripts with minimal dependencies. If you are using a framework such as plone, Django, or buildout, try to replicate the issue just using Pillow.`
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`

Rename master to main 2021-10-15 17:30:05 +03:00			`Please see our [security policy](https://github.com/python-pillow/Pillow/blob/main/.github/SECURITY.md).`