Introducing CONTRIBUTING.md

.github/ISSUE_TEMPLATE/incorrect-parsing.md

@@ -8,10 +8,10 @@ assignees: ''
 ---
 
 <!-- DO NOT THROW THIS AWAY -->
-<!-- Fill out the FULL versions with patch versions -->
+<!-- Fill out the FULL versions with patch versions (e.g. 2.10.0) -->
 
- - PHP Version: 
- - PDFParser Version: 
+ - PHP Version:
+ - PDFParser Version:
 
 ### Description:
 

.github/pull_request_template.md

@@ -11,22 +11,4 @@
 
 # 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.
--->
+In [CONTRIBUTING.md] we provide important information for contributing.

CONTRIBUTING.md

@@ -0,0 +1,22 @@
+# Contributing
+
+**Please read the following text before creating a pull request.**
+
+This project is organized and supported by community contributions and maintenance is done in our sparse time.
+We welcome any pull request that contributes to the PDFParser (code, documentation, ...).
+However, we would point out that you are initially responsible for a contribution.
+If you are new to pull requests see [Github documentation](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) for further information.
+Please don't just throw code at us and expect us to handle it.
+That being said, we will assist you and give feedback.
+
+## Important steps
+
+To make life easier for you and us, there is a continuous integration (CI) system that runs software tests and performs a number of other tasks.
+The following points describe relevant preparations/inputs for the CI system.
+All checks must be green or a pull request is not accepted.
+
+* If you add/change functionality add at least **one test case** (unit test, system test, ...) to demonstrate that your code is working. There is no need to provide a full fledged PDF file to demonstrate a fix. Instead a unit test may be sufficient sometimes, have a look at [FontTest](https://github.com/smalot/pdfparser/blob/master/tests/PHPUnit/Unit/FontTest.php#L40) for example code.
+  * :exclamation: **If you dont know how to write a test tell us upfront when opening the pull request and we may add them ourselves or discuss other ways**. This [Medium article](https://pguso.medium.com/a-beginners-guide-to-phpunit-writing-and-running-unit-tests-in-php-d0b23b96749f) might be a good point to start. Code changes without tests are very likely to be rejected.
+* Fix reported coding style issues. We use **PHP-CS-Fixer** for that. See https://github.com/smalot/pdfparser/blob/master/.php-cs-fixer.php for more information about our coding styles. See [Developer.md](./doc/Developer.md) for further information.
+* In case you **fix an existing issue**, refer to it in the intro text of the pull request. In the following the correct Markdown syntax: `fixes #1234`. This example outlines that you are providing a fix for the issue `#1234`.
+* In case **you changed internal behavior/functionality** check our documentation to make sure these changes are **documented properly**: https://github.com/smalot/pdfparser/tree/master/doc

README.md

@@ -10,6 +10,7 @@ The `smalot/pdfparser` is a standalone PHP package that provides various tools t
 
 This library is under **active maintenance**.
 There is no active development by the author of this library (at the moment), but we welcome any pull request adding/extending functionality!
+Consult [CONTRIBUTING.md](./CONTRIBUTING.md) for further information about how to contribute.
 
 ## Features