pdfminer.six/.github/pull_request_template.md

31 lines
1.2 KiB
Markdown
Raw Normal View History

2020-03-08 13:53:16 +00:00
**Pull request**
2019-10-21 21:02:50 +00:00
2020-03-08 13:53:16 +00:00
Thanks for improving pdfminer.six! Please include the following information to
help us discuss and merge this PR:
2019-10-21 21:02:50 +00:00
2020-03-08 13:53:16 +00:00
- A description of why this PR is needed. What does it fix? What does it
improve?
- A summary of the things that this PR changes.
- Reference the issues that this PR fixes (use the fixes #(issue nr) syntax).
If this PR does not fix any issue, create the issue first and mention that
you are willing to work on it.
2019-10-21 21:02:50 +00:00
**How Has This Been Tested?**
2019-10-21 21:02:50 +00:00
2020-03-08 13:53:16 +00:00
Please describe the tests that you ran to verify your changes. Provide
instructions so we can reproduce. Include an example pdf if you have one.
2019-10-21 21:02:50 +00:00
**Checklist**
2019-10-21 21:02:50 +00:00
2020-03-08 13:53:16 +00:00
- [ ] I have added tests that prove my fix is effective or that my feature
works
- [ ] I have added docstrings to newly created methods and classes
2020-03-08 13:53:16 +00:00
- [ ] I have optimized the code at least one time after creating the initial
version
- [ ] I have updated the [README.md](../README.md) or I am verified that this
is not necessary
- [ ] I have updated the [readthedocs](../docs/source) documentation or I
verified that this is not necessary
- [ ] I have added a consice human-readable description of the change to
[CHANGELOG.md](../CHANGELOG.md)