summaryrefslogtreecommitdiff
path: root/docs/CONTRIBUTING.md
diff options
context:
space:
mode:
authorZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2022-06-10 14:08:40 +0200
committerZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2022-06-10 15:04:23 +0200
commitd331f48482634e2d36641203cb5a808758d72d68 (patch)
treed8b5ee75c9704feb3a62b2e517e4dae1c3ffee6e /docs/CONTRIBUTING.md
parentf23b2a04e67f3325a066a8ab5ae352f534b3bb2b (diff)
downloadsystemd-d331f48482634e2d36641203cb5a808758d72d68.tar.gz
docs/CONTRIBUTING: ask people to send a ping on stalled reviews
A few related changes: be explicit that 'main' is the branch we're referring to. There was a case recently of somebody rebasing on 'master' by mistake. It's better to be explicit, since 'main' is still not the default for git (AFAIK). Also, github seems to send mails about force-pushes, so drop that as a justification. Commenting about changes that were done is useful even if github were to send a notification. And finally, $subject. We do that ourselves, but outside contributors might not know that that's expected.
Diffstat (limited to 'docs/CONTRIBUTING.md')
-rw-r--r--docs/CONTRIBUTING.md5
1 files changed, 3 insertions, 2 deletions
diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md
index ebfc31aa20..792b7b6ea0 100644
--- a/docs/CONTRIBUTING.md
+++ b/docs/CONTRIBUTING.md
@@ -31,13 +31,14 @@ See [reporting of security vulnerabilities](SECURITY.md).
## Posting Pull Requests
-* Make sure to post PRs only relative to a very recent git tip.
+* Make sure to post PRs only relative to a recent tip of the `main` branch.
* Follow our [Coding Style](CODING_STYLE.md) when contributing code. This is a requirement for all code we merge.
* Please make sure to test your change before submitting the PR. See the [Hacking guide](HACKING.md) for details on how to do this.
* Make sure to run the test suite locally, before posting your PR. We use a CI system, meaning we don't even look at your PR, if the build and tests don't pass.
* If you need to update the code in an existing PR, force-push into the same branch, overriding old commits with new versions.
-* After you have pushed a new version, add a comment about the new version (no notification is sent just for the commits, so it's easy to miss the update without an explicit comment). If you are a member of the systemd project on GitHub, remove the `reviewed/needs-rework` label.
+* After you have pushed a new version, add a comment. If you are a member of the systemd project on GitHub, remove the `reviewed/needs-rework` label.
* If you are copying existing code from another source (eg: a compat header), please make sure the license is compatible with LGPL-2.1-or-later. If the license is not LGPL-2.1-or-later, please add a note to LICENSES/README.md.
+* If the pull request stalls without review, post a ping in a comment after some time has passed. We are always short on reviewer time, and pull requests which haven't seen any recent activity can be easily forgotten.
## Final Words