Pillow/.github/CONTRIBUTING.md

39 lines
2.4 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
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
2014-08-04 09:05:32 +04:00
2015-04-05 03:45:47 +03:00
- Fork the Pillow repository.
2021-10-15 17:30:05 +03:00
- Create a branch from `main`.
2015-04-05 03:45:47 +03:00
- 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.
2021-10-15 17:30:05 +03:00
- Create a pull request to pull the changes from your branch to the Pillow `main`.
2015-04-05 03:45:47 +03:00
### 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.
2019-09-26 15:12:28 +03:00
- Follow PEP 8.
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.
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.
2015-04-05 03:45:47 +03:00
## Reporting Issues
2014-07-27 14:14:28 +04: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.
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
2021-10-15 17:30:05 +03:00
Please see our [security policy](https://github.com/python-pillow/Pillow/blob/main/.github/SECURITY.md).