docs/CONTRIBUTING.md

   1 ---
   2 title: Contributing
   3 category: Contributing
   4 layout: default
   5 SPDX-License-Identifier: LGPL-2.1-or-later
   6 ---
   7
   8 # Contributing
   9
  10 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:
  11
  12 ## Filing Issues
  13
  14 * We use [GitHub Issues](https://github.com/systemd/systemd/issues) **exclusively** for tracking **bugs** and **feature** **requests** (RFEs) of systemd. If you are looking for help, please try the forums of your distribution first, or [systemd-devel mailing list](https://lists.freedesktop.org/mailman/listinfo/systemd-devel) for general questions about systemd.
  15 * We only track bugs in the **two** **most** **recently** **released** (non-rc) **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 (see below). See [GitHub Release Page](https://github.com/systemd/systemd/releases) for the list of most recent releases.
  16 * When filing a feature request issue (RFE), please always check first if the newest upstream version of systemd already implements the feature, and whether there's already an issue filed for your feature by someone else.
  17 * When filing an issue, specify the **systemd** **version** you are experiencing the issue with. Also, indicate which **distribution** you are using.
  18 * Please include an explanation how to reproduce the issue you are pointing out.
  19
  20 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.
  21
  22 ### Older downstream versions
  23
  24 For older versions that are still supported by your distribution please use respective downstream tracker:
  25
  26 * **Fedora** - [bugzilla](https://bugzilla.redhat.com/enter_bug.cgi?product=Fedora&component=systemd)
  27 * **RHEL/CentOS stream** - [Jira](https://issues.redhat.com/secure/CreateIssueDetails!init.jspa?pid=12332745&issuetype=1&components=12380515&priority=10300) or [contribute to systemd-rhel @GitHub](https://github.com/redhat-plumbers#systemd)
  28 * **Debian** - [bugs.debian.org](https://bugs.debian.org/cgi-bin/pkgreport.cgi?pkg=systemd)
  29
  30 ## Security vulnerability reports
  31
  32 See [reporting of security vulnerabilities](SECURITY.md).
  33
  34 ## Posting Pull Requests
  35
  36 * Make sure to post PRs only relative to a recent tip of the `main` branch.
  37 * Follow our [Coding Style](CODING_STYLE.md) when contributing code. This is a requirement for all code we merge.
  38 * Please make sure to test your change before submitting the PR. See the [Hacking guide](HACKING.md) for details on how to do this.
  39 * 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.
  40 * If you need to update the code in an existing PR, force-push into the same branch, overriding old commits with new versions.
  41 * After you have pushed a new version, add a comment explaining the latest changes. If you are a member of the systemd project on GitHub, remove the `reviewed/needs-rework`/`ci-fails/needs-rework`/`needs-rebase` labels.
  42 * 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`](https://github.com/systemd/systemd/blob/main/LICENSES/README.md).
  43 * 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.
  44 * Github will automatically add the `please-review` label when a pull request is opened or updated. If you need
  45 more information after a review, you can comment `/please-review` on the pull request to have Github add the
  46 `please-review` label to the pull request.
  47
  48 ## Reviewing Pull Requests
  49
  50 * See [filtered list of pull requests](https://github.com/systemd/systemd/pulls?q=is%3Aopen+is%3Apr+-label%3A%22reviewed%2Fneeds-rework+%F0%9F%94%A8%22+-label%3Aneeds-rebase+-label%3Agood-to-merge%2Fwith-minor-suggestions+-label%3A%22good-to-merge%2Fwaiting-for-ci+%F0%9F%91%8D%22+-label%3Apostponed+-label%3A%22needs-reporter-feedback+%E2%9D%93%22+-label%3A%22dont-merge+%F0%9F%92%A3%22+-label%3A%22ci-fails%2Fneeds-rework+%F0%9F%94%A5%22+sort%3Aupdated-desc) for requests that are ready for review.
  51 * After performing a review, set
  52
  53   * `reviewed/needs-rework` if the pull request needs significant changes
  54   * `ci-fails/needs-rework` if the automatic tests fail and the failure is relevant to the pull request
  55   * `ci-failure-appears-unrelated` if the test failures seem irrelevant
  56   * `needs-rebase` if the pull request needs a rebase because of conflicts
  57   * `good-to-merge/waiting-for-ci` if the pull request should be merged without further review
  58   * `good-to-merge/with-minor-suggestions` if the pull request should be merged after an update without going through another round of reviews
  59
  60 Unfortunately only members of the `systemd` organization on github can change labels.
  61 If your pull request is mislabeled, make a comment in the pull request and somebody will fix it.
  62 Reviews from non-members are still welcome.
  63
  64 ## Final Words
  65
  66 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!
  67
  68 Thank you very much for your contributions!
  69
  70 # Backward Compatibility And External Dependencies
  71
  72 We strive to keep backward compatibility where possible and reasonable. The following are general guidelines, not hard
  73 rules, and case-by-case exceptions might be applied at the discretion of the maintainers. The current set of build-time
  74 and runtime dependencies are documented in the [README](https://github.com/systemd/systemd/blob/main/README).
  75
  76 ## New features
  77
  78 It is fine for new features/functionality/tools/daemons to require bleeding edge external dependencies, provided there
  79 are runtime and build-time graceful fallbacks (e.g.: a daemon will not be built, runtime functionality will be skipped with a clear log message).
  80 In case a new feature is added to both `systemd` and one of its dependencies, we expect the corresponding feature code to
  81 be merged upstream in the dependency before accepting our side of the implementation.
  82 Making use of new kernel syscalls can be achieved through compat wrappers in our tree (see: `src/basic/missing_syscall_def.h`),
  83 and does not need to wait for glibc support.
  84
  85 ## External Build/Runtime Dependencies
  86
  87 It is often tempting to bump external dependencies' minimum versions to cut cruft, and in general it's an essential part
  88 of the maintenance process. But as a general rule, existing dependencies should not be bumped without strong
  89 reasons. When possible, we try to keep compatibility with the most recent LTS releases of each mainstream distribution
  90 for optional components, and with all currently maintained (i.e.: not EOL) LTS releases for core components. When in
  91 doubt, ask before committing time to work on contributions if it's not clear that cutting support would be obviously
  92 acceptable.
  93
  94 ## Kernel Requirements
  95
  96 Same principles as with other dependencies should be applied. It is fine to require newer kernel versions for additional
  97 functionality or optional features, but very strong reasons should be required for breaking compatibility for existing
  98 functionality, especially for core components. It is not uncommon, for example, for embedded systems to be stuck on older
  99 kernel versions due to hardware requirements, so do not assume everybody is running with latest and greatest at all times.
 100 In general, [currently maintained LTS branches](https://www.kernel.org/category/releases.html) should keep being supported
 101 for existing functionality.
 102
 103 ## `libsystemd.so`
 104
 105 `libsystemd.so` is a shared public library, so breaking ABI/API compatibility would create lot of work for everyone, and is not allowed. Instead, always add a new interface instead of modifying
 106 the signature of an existing function. It is fine to mark an interface as deprecated to gently nudge users toward a newer one,
 107 but support for the old one must be maintained.
 108 Symbol versioning and the compiler's deprecated attribute should be used when managing the lifetime of a public interface.
 109
 110 ## `libudev.so`
 111
 112 `libudev.so` is a shared public library, and is still maintained, but should not gain new symbols at this point.