diff options
Diffstat (limited to '.github/CONTRIBUTING.md')
| -rw-r--r-- | .github/CONTRIBUTING.md | 27 |
1 files changed, 10 insertions, 17 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 60f0fb9bef..8a6db1f629 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,34 +1,27 @@ # Contributing -We welcome contributions from everyone. However, please follow the following guidelines when posting a GitHub Pull -Request or filing a GitHub Issue on the systemd project: +We welcome contributions from everyone. However, please follow the following guidelines when posting a GitHub Pull Request or filing a GitHub Issue on the systemd project: ## Filing Issues -* We use GitHub Issues **exclusively** for tracking **bugs** and **feature** **requests** of systemd. If you are - looking for help, please contact our [mailing list](http://lists.freedesktop.org/mailman/listinfo/systemd-devel) - instead. -* We only track bugs in the **two** **most** **recently** **released** **versions** of systemd in the GitHub Issue - tracker. If you are using an older version of systemd, please contact your distribution's bug tracker instead. -* When filing an issue, specify the **systemd** **version** you are experiencing the issue with. Also, indicate which - **distribution** you are using. +* We use GitHub Issues **exclusively** for tracking **bugs** and **feature** **requests** of systemd. If you are looking for help, please contact our [mailing list](http://lists.freedesktop.org/mailman/listinfo/systemd-devel) instead. +* We only track bugs in the **two** **most** **recently** **released** **versions** of systemd in the GitHub Issue tracker. If you are using an older version of systemd, please contact your distribution's bug tracker instead. +* When filing an issue, specify the **systemd** **version** you are experiencing the issue with. Also, indicate which **distribution** you are using. * Please include an explanation how to reproduce the issue you are pointing out. -Following these guidelines makes it easier for us to process your issue, and ensures we won't close your issue -right-away for being misfiled. +Following these guidelines makes it easier for us to process your issue, and ensures we won't close your issue right-away for being misfiled. ## Posting Pull Requests * Make sure to post PRs only relative to a very recent git master. -* Follow our [Coding Style](https://raw.githubusercontent.com/systemd/systemd/master/CODING_STYLE) when contributing - code. This is a requirement for all code we merge. -* Make sure to run "make check" 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. +* Follow our [Coding Style](https://raw.githubusercontent.com/systemd/systemd/master/CODING_STYLE) when contributing code. This is a requirement for all code we merge. +* Please make sure to test your change before submitting the PR. See [HACKING](https://raw.githubusercontent.com/systemd/systemd/master/HACKING) for details how to do this. +* Make sure to run "make check" 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, try to remove the `reviewed/needs-rework` label. Also 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). ## Final Words -We'd like to apologize in advance if we are not able to process and reply to your issue or PR right-away. We have a lot -of work to do, but we are trying our best! +We'd like to apologize in advance if we are not able to process and reply to your issue or PR right-away. We have a lot of work to do, but we are trying our best! Thank you very much for your contributions! |