shaba/systemd-stable
1
1
Fork 0
mirror of https://github.com/systemd/systemd-stable.git synced 2024-12-23 17:34:00 +03:00
Code
14c4da2ffe
systemd-stable/docs/CONTRIBUTING.md

38 lines
3.4 KiB
Markdown
Raw Normal View History

github: add a CONTRIBUTING.md file that github shows when a PR or issue is filed github links up CONTRIBUTING.md if it exists from the issue/PR filing form. Let's add one, in the hope that people have a look before filing a PR.
2016-01-22 14:02:03 +03:00
# Contributing
CONTRIBUTING: remove line wrapping GitHub displays this file poorly, because it preserves the newlines. Let's try how things look without any wrapping.
2016-05-31 20:27:41 +03:00
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:
github: add a CONTRIBUTING.md file that github shows when a PR or issue is filed github links up CONTRIBUTING.md if it exists from the issue/PR filing form. Let's add one, in the hope that people have a look before filing a PR.
2016-01-22 14:02:03 +03:00
## Filing Issues
docs: use https in the mailing list url
2017-03-07 18:04:45 +03:00
* We use GitHub Issues **exclusively** for tracking **bugs** and **feature** **requests** of systemd. If you are looking for help, please contact our [mailing list](https://lists.freedesktop.org/mailman/listinfo/systemd-devel) instead.
CONTRIBUTING: remove line wrapping GitHub displays this file poorly, because it preserves the newlines. Let's try how things look without any wrapping.
2016-05-31 20:27:41 +03:00
* 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.
github: add a CONTRIBUTING.md file that github shows when a PR or issue is filed github links up CONTRIBUTING.md if it exists from the issue/PR filing form. Let's add one, in the hope that people have a look before filing a PR.
2016-01-22 14:02:03 +03:00
* Please include an explanation how to reproduce the issue you are pointing out.
CONTRIBUTING: remove line wrapping GitHub displays this file poorly, because it preserves the newlines. Let's try how things look without any wrapping.
2016-05-31 20:27:41 +03:00
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.
github: add a CONTRIBUTING.md file that github shows when a PR or issue is filed github links up CONTRIBUTING.md if it exists from the issue/PR filing form. Let's add one, in the hope that people have a look before filing a PR.
2016-01-22 14:02:03 +03:00
github: how to report bugs for older distribution versions (#6146)
2017-06-20 21:20:25 +03:00
### Older downstream versions
For older versions that are still supported by your distribution please use respective downstream tracker:
* **Fedora** - [bugzilla](https://bugzilla.redhat.com/enter_bug.cgi?product=Fedora&component=systemd)
* **RHEL-7/CentOS-7** - [bugzilla](https://bugzilla.redhat.com/enter_bug.cgi?product=Red%20Hat%20Enterprise%20Linux%207&component=systemd) or [systemd-rhel github](https://github.com/lnykryn/systemd-rhel/issues)
* **Debian** - [bugs.debian.org](https://bugs.debian.org/cgi-bin/pkgreport.cgi?pkg=systemd)
docs: add a note about reporting security vulns (#5541) We *do* have the occasional security issue, where it would be nice to have non-public disclosure and time to fix the issue before it's fully public. Our github infrastracture does not make it easy to report vulnerabilities in confidential manner, so let's leverage the distro mechanisms for that. I think we're better off with this solution than leaving it up to individual reporters to discover some mechanism on their own.
2017-03-07 16:33:27 +03:00
## Security vulnerability reports
If you discover a security vulnerability, we'd appreciate a non-public disclosure. The issue tracker and mailing list listed above are fully public. If you need to reach systemd developers in a non-public way, report the issue in one of the "big" distributions using systemd: [Fedora](https://bugzilla.redhat.com/enter_bug.cgi?product=Fedora&component=systemd) (be sure to check "Security Sensitive Bug" under "Show Advanced Fields"), [Ubuntu](https://launchpad.net/ubuntu/+source/systemd/+filebug) (be sure to change "This bug contains information that is" from "Public" to "Private Security"), or [Debian](mailto:security@debian.org). Various systemd developers are active distribution maintainers and will propagate the information about the bug to other parties.
github: add a CONTRIBUTING.md file that github shows when a PR or issue is filed github links up CONTRIBUTING.md if it exists from the issue/PR filing form. Let's add one, in the hope that people have a look before filing a PR.
2016-01-22 14:02:03 +03:00
## Posting Pull Requests
* Make sure to post PRs only relative to a very recent git master.
docs: Update links to updated docs
2018-10-30 20:31:20 +03:00
* 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.
CONTRIBUTING: stop mentioning "make check" Since the switch to meson this information is no longer valid. HACKING already documents how to run the test suite. See #6642
2017-08-21 10:47:07 +03:00
* 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.
CONTRIBUTING: recommend force-push (#3273)
2016-05-16 22:44:35 +03:00
* If you need to update the code in an existing PR, force-push into the same branch, overriding old commits with new versions.
Docs: Fix spelling and capitalization (#7408)
2017-11-21 16:37:16 +03:00
* 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.
github: add a CONTRIBUTING.md file that github shows when a PR or issue is filed github links up CONTRIBUTING.md if it exists from the issue/PR filing form. Let's add one, in the hope that people have a look before filing a PR.
2016-01-22 14:02:03 +03:00
## Final Words
CONTRIBUTING: remove line wrapping GitHub displays this file poorly, because it preserves the newlines. Let's try how things look without any wrapping.
2016-05-31 20:27:41 +03:00
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!
github: add a CONTRIBUTING.md file that github shows when a PR or issue is filed github links up CONTRIBUTING.md if it exists from the issue/PR filing form. Let's add one, in the hope that people have a look before filing a PR.
2016-01-22 14:02:03 +03:00
Thank you very much for your contributions!
Copy Permalink