Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a pull request template which contains helpful information #633

Merged
merged 9 commits into from
Aug 22, 2023
30 changes: 30 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Type of pull request

* [ ] Bug fix (involves code and configuration changes)
* [ ] New feature (involves code and configuration changes)
* [ ] Documentation update
* [ ] Something else

# About

*Please describe with a few words what this pull request is about*
k00ni marked this conversation as resolved.
Show resolved Hide resolved

# Checklist for code/confirmation changes

*In case you changed the code/configuration, please read each of the following checkboxes as they contain valuable information:*

* [ ] Please add at least **one test case** (unit test, system test, ...) to demonstrate that the change is working. If existing code was changed, your tests cover these code parts as well.
By the way, you don't have to provide a full fledged PDF file to demonstrate a fix. Instead a unit test may sufficient sometimes,
please have a look at [FontTest](https://github.com/smalot/pdfparser/blob/master/tests/PHPUnit/Unit/FontTest.php#L40) for example code.
Code changes without any tests are likely to be rejected. If you dont know how to write tests, no problem, tell us upfront and we may add them ourselves or discuss other ways.
* [ ] Please run **PHP-CS-Fixer** before committing, to confirm with our coding styles. See https://github.com/smalot/pdfparser/blob/master/.php-cs-fixer.php for more information about our coding styles.
* [ ] In case you **fix an existing issue**, please do one of the following:
* [ ] Write in this text something like `fixes #1234` to outline that you are providing a fix for the issue `#1234`.
* [ ] After the pull request was created, you will find on the right side a section called **Development**. There issues can be selected which will be closed after the your pull request got merged.
* [ ] In case you changed internal behavior or functionality, please check our documentation to make sure these changes are **documented properly**: https://github.com/smalot/pdfparser/tree/master/doc
* [ ] In case you wanna discuss new ideas/changes and you are not sure, just create a pull request and mark it as **a draft**
k00ni marked this conversation as resolved.
Show resolved Hide resolved
(see [here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests#draft-pull-requests) for more information).
This will tell us, that it is not ready for merge, but you want to discuss certain issues.

Pull requests will be declined/rejected if one part of the continous integration pipeline fails.
We use the pipeline to make sure no regressions are introduced and existing code still runs as expected.
k00ni marked this conversation as resolved.
Show resolved Hide resolved
Loading