docs: add a pull_request_template (#897)

* Create pull_request_template.md

* Generate documentation preview in CI

* Add review comments

* Use message-template to link to the rendered PR docs nicely

* Fix review finding

* Replace single-language with single-version to circumvent bug with wrong url in PR description

Author: mhoff

.github/pull_request_template.md

@@ -0,0 +1,30 @@
+## Description
+
+* Briefly summarize your changes in a few bullet points (can and should correspond to [CHANGELOG.md](https://github.com/fkie-cad/Logprep/blob/main/CHANGELOG.md))
+* Relates to #XXX (insert issue number here), if there is a corresponding GH issue
+
+## Assignee
+- [ ] The changes adhere to the [contribution guidelines](https://github.com/fkie-cad/Logprep/blob/main/CONTRIBUTING.md)
+- [ ] I have performed a self-review of my code
+- [ ] My changes generate no new warnings (e.g. flake8/mypy/pytest/...) other than deprecations
+
+### Documentation
+- [ ] [README.md](https://github.com/fkie-cad/Logprep/blob/main/README.md) is up-to-date
+- [ ] [CHANGELOG.md](https://github.com/fkie-cad/Logprep/blob/main/CHANGELOG.md) is up-to-date
+- [ ] [Documentation](https://github.com/fkie-cad/Logprep/tree/main/doc/source) (doc/source) is up-to-date
+- [ ] [Preview for docs](#readthedocs-preview) looks fine
+- [ ] [Notebooks](https://github.com/fkie-cad/Logprep/tree/main/doc/source/development/notebooks) are up-to-date and functional
+- [ ] [Examples](https://github.com/fkie-cad/Logprep/tree/main/examples) are up-to-date and functional (including compose & k8s)
+
+### Code Quality
+- [ ] Patch test coverage > 95% and does not decrease
+- [ ] New code uses correct & specific type hints
+
+### How did you verify that the changes work in practice?
+
+* List of (preferably easy reproducible) tests including OS
+
+## Reviewer
+- [ ] The code is readable/maintainable and follows the [contribution guidelines](https://github.com/fkie-cad/Logprep/blob/main/CONTRIBUTING.md)
+- [ ] [Documentation](#documentation) is up-to-date
+- [ ] Tests (unit & acceptance) are meaningful and not over-mocked

.github/workflows/ci.yml

@@ -33,6 +33,16 @@ jobs:
           cd doc
           sphinx-apidoc -fT -o source/module_reference ../logprep
           make clean html
+  documentation-preview:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: readthedocs/actions/preview@v1
+        with:
+          project-slug: logprep
+          project-language: en
+          platform: community
+          single-version: 'true'
+          message-template: "---\n<a name=\"readthedocs-preview\"></a>The rendered docs for this PR can be found [here]({docs-pr-index-url})."
   code-quality:
     uses: ./.github/workflows/code-quality.yml
     secrets: inherit