From c2beadcd34d2b1da1a16330377d484dedfbc8a32 Mon Sep 17 00:00:00 2001 From: Filipe Brandenburger Date: Fri, 7 Sep 2018 01:07:06 -0700 Subject: [PATCH] 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/. --- .github/ISSUE_TEMPLATE/Bug_report.md | 2 +- {.github => docs}/CONTRIBUTING.md | 0 docs/HACKING | 2 +- {.github => docs}/RELEASE.md | 0 4 files changed, 2 insertions(+), 2 deletions(-) rename {.github => docs}/CONTRIBUTING.md (100%) rename {.github => docs}/RELEASE.md (100%) diff --git a/.github/ISSUE_TEMPLATE/Bug_report.md b/.github/ISSUE_TEMPLATE/Bug_report.md index cea1c655b9..6a0b5527d0 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 > ... - + **Used distribution** > … diff --git a/.github/CONTRIBUTING.md b/docs/CONTRIBUTING.md similarity index 100% rename from .github/CONTRIBUTING.md rename to docs/CONTRIBUTING.md diff --git a/docs/HACKING b/docs/HACKING index c7b700e6a7..1778e4822d 100644 --- a/docs/HACKING +++ b/docs/HACKING @@ -9,7 +9,7 @@ Request (PR): Please make sure to follow our Coding Style when submitting patches. See docs/CODING_STYLE for details. Also have a look at our Contribution Guidelines: - https://github.com/systemd/systemd/blob/master/.github/CONTRIBUTING.md + https://github.com/systemd/systemd/blob/master/docs/CONTRIBUTING.md When adding new functionality, tests should be added. For shared functionality (in src/basic and src/shared) unit tests should be sufficient. The general diff --git a/.github/RELEASE.md b/docs/RELEASE.md similarity index 100% rename from .github/RELEASE.md rename to docs/RELEASE.md