diff options
author | 2018-09-07 01:07:06 -0700 | |
---|---|---|
committer | 2018-09-08 13:39:03 -0700 | |
commit | c2beadcd34d2b1da1a16330377d484dedfbc8a32 (patch) | |
tree | 2df4d753212d05e6459da06cdc1c78246754f4e9 /.github | |
parent | docs: move doc/ to docs/ (diff) | |
download | systemd-c2beadcd34d2b1da1a16330377d484dedfbc8a32.tar.gz systemd-c2beadcd34d2b1da1a16330377d484dedfbc8a32.tar.bz2 systemd-c2beadcd34d2b1da1a16330377d484dedfbc8a32.zip |
docs: move markdown docs from .github/ to docs/
The GitHub guide on contributing file says: "Decide whether to store your
contributing guidelines in your repository's root, docs, or .github directory."
https://help.github.com/articles/setting-guidelines-for-repository-contributors/#adding-a-contributing-file
But there's really no advantage to keeping it in the hidden .github/, since
these are public and really belong together with the other documentation.
We can still keep the issue templates under .github/, since they are not really
documentation on their own.
Updated the links pointing to CONTRIBUTING.md to refer to the one in docs/.
Diffstat (limited to '.github')
-rw-r--r-- | .github/CONTRIBUTING.md | 37 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/Bug_report.md | 2 | ||||
-rw-r--r-- | .github/RELEASE.md | 12 |
3 files changed, 1 insertions, 50 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md deleted file mode 100644 index ea15325fe..000000000 --- a/.github/CONTRIBUTING.md +++ /dev/null @@ -1,37 +0,0 @@ -# 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: - -## 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](https://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. - -### 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) - -## 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. - -## 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/docs/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/docs/HACKING) for details 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. - -## 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! - -Thank you very much for your contributions! diff --git a/.github/ISSUE_TEMPLATE/Bug_report.md b/.github/ISSUE_TEMPLATE/Bug_report.md index cea1c655b..6a0b5527d 100644 --- a/.github/ISSUE_TEMPLATE/Bug_report.md +++ b/.github/ISSUE_TEMPLATE/Bug_report.md @@ -8,7 +8,7 @@ about: A report of an error in a recent systemd version > ... <!-- **NOTE:** Do not submit bug reports about anything but the two most recently released systemd versions upstream! --> -<!-- For older version please use distribution trackers (see https://github.com/systemd/systemd/blob/master/.github/CONTRIBUTING.md#filing-issues). --> +<!-- For older version please use distribution trackers (see https://github.com/systemd/systemd/blob/master/docs/CONTRIBUTING.md#filing-issues). --> **Used distribution** > … diff --git a/.github/RELEASE.md b/.github/RELEASE.md deleted file mode 100644 index 2807667a3..000000000 --- a/.github/RELEASE.md +++ /dev/null @@ -1,12 +0,0 @@ -# Steps to a successful release - -1. Add all items to NEWS -2. Update the contributors list in NEWS ("make git-contrib") -3. Update the time and place in NEWS -4. Update version in configure.ac and library numbers in Makefile.am -5. Check that "make distcheck" works -6. Tag the release ("make git-tag") -7. Upload the documentation ("make doc-sync") -8. Close the github milestone and open a new one (https://github.com/systemd/systemd/milestones) -9. Send announcement to systemd-devel, with a copy&paste from NEWS -10. Update IRC topic ("/msg chanserv TOPIC #systemd Version NNN released") |