github: improve description of basics of PRs
## Basics
-Check relevant points but **please do not remove entries**.
-Do not describe the purpose of this PR in the PR description but:
+These points need to be fulfilled for every PR:
-- [ ] Short descriptions should be in the release notes (added as entry in
- `doc/news/_preparation_next_release.md` which contains `_(my name)_`)
- **Please always add something to the the release notes.**
-- [ ] Longer descriptions should be in documentation or in design decisions.
-- [ ] Describe details of how you changed the code in commit messages
+- [ ] Short descriptions of your changes are in the release notes
+ (added as entry in `doc/news/_preparation_next_release.md` which
+ contains `_(my name)_`)
+ **Please always add something to the release notes.**
+- [ ] Details of what you changed are in commit messages
(first line should have `module: short statement` syntax)
-- [ ] References to issues, e.g. `close #X`, should be in the commit messages.
+- [ ] References to issues, e.g. `close #X`, are in the commit messages.
+- [ ] The buildservers are happy.
+- [ ] The PR is rebased with current master.
+
+If you have any troubles fulfilling these criteria, please write
+about the trouble as comment in the PR. We will help you.
+But we cannot accept PRs that do not fulfill the basics.
## Checklist
@@ -18,6 +23,8 @@ For docu fixes, spell checking, and similar none of these points below
need to be checked.
- [ ] I added unit tests for my code
+- [ ] I fully described what my PR does in the documentation
+ (not in the PR description)
- [ ] I fixed all affected documentation
- [ ] I added code comments, logging, and assertions as appropriate (see [Coding Guidelines](https://master.libelektra.org/doc/CODING.md))
- [ ] I updated all meta data (e.g. README.md of plugins and [METADATA.ini](https://master.libelektra.org/doc/METADATA.ini))
@@ -27,7 +34,7 @@ need to be checked.
Reviewers will usually check the following:
-- [ ] Documentation is introductory, concise and good to read
+- [ ] Documentation is introductory, concise, good to read and describes everything what the PR does
- [ ] Examples are well chosen and understandable
- [ ] Code is conforming to [our Coding Guidelines](https://master.libelektra.org/doc/CODING.md)
- [ ] APIs are conforming to [our Design Guidelines](https://master.libelektra.org/doc/DESIGN.md)
@@ -35,6 +42,8 @@ Reviewers will usually check the following:
## Labels
+If you are already Elektra developer:
+
- Add the "work in progress" label if you do not want the PR to be reviewed yet.
-- Add the "ready to merge" label **if the build server is happy** and also you
+- Add the "ready to merge" label **if the basics are fulfilled** and you also
say that everything is ready to be merged.
