From 6d4d8200bfc35a2bb03a7cef26519a59f15ab65f Mon Sep 17 00:00:00 2001 From: Konrad Abicht Date: Wed, 16 Aug 2023 13:27:50 +0200 Subject: [PATCH 1/9] Create pull_request_template.md --- .github/pull_request_template.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..59c55e4a --- /dev/null +++ b/.github/pull_request_template.md @@ -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* + +# 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 is sufficient, + 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`. + * [ ] On the right side in section **Development**, you can also select issues that will be closed after your pull request gets merged. Both ways lead to the same result. +* [ ] 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** + (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. From cbf2101593492556fd34ababaf3e26b21d11487f Mon Sep 17 00:00:00 2001 From: Konrad Abicht Date: Wed, 16 Aug 2023 13:32:47 +0200 Subject: [PATCH 2/9] Update pull_request_template.md --- .github/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 59c55e4a..a4f7cee2 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -14,7 +14,7 @@ *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 is sufficient, + 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. From 4b0ccf4831e952067d09baf6e356f521385e8f0b Mon Sep 17 00:00:00 2001 From: Konrad Abicht Date: Wed, 16 Aug 2023 13:34:29 +0200 Subject: [PATCH 3/9] Update pull_request_template.md --- .github/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index a4f7cee2..b0437d55 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -20,7 +20,7 @@ * [ ] 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`. - * [ ] On the right side in section **Development**, you can also select issues that will be closed after your pull request gets merged. Both ways lead to the same result. + * [ ] 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** (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). From 21bb7a8da9b9f6e47374021d08cf8a34e1376f61 Mon Sep 17 00:00:00 2001 From: Konrad Abicht Date: Mon, 21 Aug 2023 16:31:05 +0200 Subject: [PATCH 4/9] Update .github/pull_request_template.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Jérémy Benoist --- .github/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index b0437d55..5ce1a52e 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -7,7 +7,7 @@ # About -*Please describe with a few words what this pull request is about* + # Checklist for code/confirmation changes From b137c0d58138ea934058513f227b72191943b0d5 Mon Sep 17 00:00:00 2001 From: Konrad Abicht Date: Mon, 21 Aug 2023 16:31:20 +0200 Subject: [PATCH 5/9] Update .github/pull_request_template.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Jérémy Benoist --- .github/pull_request_template.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 5ce1a52e..bc2b3f00 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -26,5 +26,7 @@ (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. + From f1b6d97b85ed6583733f8411a65ed43c35d5dc6e Mon Sep 17 00:00:00 2001 From: Konrad Abicht Date: Mon, 21 Aug 2023 16:31:30 +0200 Subject: [PATCH 6/9] Update .github/pull_request_template.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Jérémy Benoist --- .github/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index bc2b3f00..8d8602af 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -22,7 +22,7 @@ * [ ] 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** +* [ ] 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. From 5de8b0050cece140c01345be752174b04f1b5c63 Mon Sep 17 00:00:00 2001 From: Konrad Abicht Date: Mon, 21 Aug 2023 16:36:45 +0200 Subject: [PATCH 7/9] Update pull_request_template.md --- .github/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 8d8602af..3ff23521 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -9,7 +9,7 @@ -# Checklist for code/confirmation changes +# Checklist for code / configuration changes *In case you changed the code/configuration, please read each of the following checkboxes as they contain valuable information:* From 8acd1875411ca8781f96bd448b96751748db29d2 Mon Sep 17 00:00:00 2001 From: Konrad Abicht Date: Tue, 22 Aug 2023 09:30:54 +0200 Subject: [PATCH 8/9] fixed coding style issue in Parser.php --- src/Smalot/PdfParser/Parser.php | 1 + 1 file changed, 1 insertion(+) diff --git a/src/Smalot/PdfParser/Parser.php b/src/Smalot/PdfParser/Parser.php index 3078f9e6..d3cac625 100644 --- a/src/Smalot/PdfParser/Parser.php +++ b/src/Smalot/PdfParser/Parser.php @@ -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() From 48e0526cdb642687a485bb26d608fc7d7b5b698c Mon Sep 17 00:00:00 2001 From: Konrad Abicht Date: Tue, 22 Aug 2023 12:31:36 +0200 Subject: [PATCH 9/9] Update pull_request_template.md --- .github/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 3ff23521..a130ef15 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -14,7 +14,7 @@ *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, + 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.