Skip to content

Commit

Permalink
Add a pull request template which contains helpful information (#633)
Browse files Browse the repository at this point in the history
* Create pull_request_template.md

* Update pull_request_template.md

* Update pull_request_template.md

* Update .github/pull_request_template.md

Co-authored-by: Jérémy Benoist <j0k3r@users.noreply.github.com>

* Update .github/pull_request_template.md

Co-authored-by: Jérémy Benoist <j0k3r@users.noreply.github.com>

* Update .github/pull_request_template.md

Co-authored-by: Jérémy Benoist <j0k3r@users.noreply.github.com>

* Update pull_request_template.md

* fixed coding style issue in Parser.php

* Update pull_request_template.md

---------

Co-authored-by: Jérémy Benoist <j0k3r@users.noreply.github.com>
  • Loading branch information
k00ni and j0k3r authored Aug 22, 2023
1 parent f3a5a3e commit 81482e8
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 0 deletions.
32 changes: 32 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# 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 -->

# Checklist for code / configuration 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 be 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 want to discuss new ideas/changes and you are not sure, just create a pull request and mark it as **a draft**
(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.
-->
1 change: 1 addition & 0 deletions src/Smalot/PdfParser/Parser.php
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ public function getConfig(): Config
public function parseFile(string $filename): Document
{
$content = file_get_contents($filename);

/*
* 2018/06/20 @doganoo as multiple times a
* users have complained that the parseFile()
Expand Down

0 comments on commit 81482e8

Please sign in to comment.