From d76b42c680e202ceea5c6db9526b41ce62d60df8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Niklas=20Hamb=C3=BCchen?= Date: Sat, 26 Jun 2021 04:37:39 +0200 Subject: [PATCH] CONTRIBUTING.md: Move to repo root, where it is more visible. We found that many users found it difficult to locate this document. Github supports it in the root, see: https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors (cherry picked from commit 3c29ced243cc032806f680ae67845b9b3a879183) This fixes the links on the nixos.org website, the stable branch docs point to master on github, so both master and the release branch need to have the file in the same location. fixes https://github.com/NixOS/nixos-homepage/issues/736 --- .github/CONTRIBUTING.md => CONTRIBUTING.md | 0 README.md | 2 +- doc/contributing/submitting-changes.chapter.md | 4 ++-- 3 files changed, 3 insertions(+), 3 deletions(-) rename .github/CONTRIBUTING.md => CONTRIBUTING.md (100%) diff --git a/.github/CONTRIBUTING.md b/CONTRIBUTING.md similarity index 100% rename from .github/CONTRIBUTING.md rename to CONTRIBUTING.md diff --git a/README.md b/README.md index 8f52d915005..c75570acde2 100644 --- a/README.md +++ b/README.md @@ -87,7 +87,7 @@ Most contributions are based on and merged into these branches: deemed of sufficiently high quality For more information about contributing to the project, please visit -the [contributing page](https://github.com/NixOS/nixpkgs/blob/master/.github/CONTRIBUTING.md). +the [contributing page](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md). # Donations diff --git a/doc/contributing/submitting-changes.chapter.md b/doc/contributing/submitting-changes.chapter.md index e360dba5abd..4b4b0411821 100644 --- a/doc/contributing/submitting-changes.chapter.md +++ b/doc/contributing/submitting-changes.chapter.md @@ -62,7 +62,7 @@ - Push your changes to your fork of nixpkgs. - Create the pull request -- Follow [the contribution guidelines](https://github.com/NixOS/nixpkgs/blob/master/.github/CONTRIBUTING.md#submitting-changes). +- Follow [the contribution guidelines](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md#submitting-changes). ## Submitting security fixes {#submitting-changes-submitting-security-fixes} @@ -191,7 +191,7 @@ It’s important to test any executables generated by a build when you change or ### Meets Nixpkgs contribution standards {#submitting-changes-contribution-standards} -The last checkbox is fits [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/.github/CONTRIBUTING.md). The contributing document has detailed information on standards the Nix community has for commit messages, reviews, licensing of contributions you make to the project, etc\... Everyone should read and understand the standards the community has for contributing before submitting a pull request. +The last checkbox is fits [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md). The contributing document has detailed information on standards the Nix community has for commit messages, reviews, licensing of contributions you make to the project, etc\... Everyone should read and understand the standards the community has for contributing before submitting a pull request. ## Hotfixing pull requests {#submitting-changes-hotfixing-pull-requests}