From 9e035c914dd1623acc0472e98eb57180cfc0327b Mon Sep 17 00:00:00 2001 From: Ingolf Wagner Date: Fri, 3 Jan 2020 15:57:52 +1300 Subject: [PATCH] doc/submitting-changes : improved section 15.1 --- doc/contributing/submitting-changes.xml | 63 +++++++------------------ 1 file changed, 16 insertions(+), 47 deletions(-) diff --git a/doc/contributing/submitting-changes.xml b/doc/contributing/submitting-changes.xml index f283ae1e6851..73222c1a49ac 100644 --- a/doc/contributing/submitting-changes.xml +++ b/doc/contributing/submitting-changes.xml @@ -13,7 +13,7 @@ - Fork the repository on GitHub. + Fork the Nixpkgs repository on GitHub. @@ -22,15 +22,10 @@ - You can make branch from a commit of your local nixos-version. That will help you to avoid additional local compilations. Because you will receive packages from binary cache. - - - - For example: nixos-version returns 15.05.git.0998212 (Dingo). So you can do: - - - + You can make branch from a commit of your local nixos-version. That will help you to avoid additional local compilations. Because you will receive packages from binary cache. For example +$ nixos-version --hash +0998212 $ git checkout 0998212 $ git checkout -b 'fix/pkg-name-update' @@ -47,13 +42,11 @@ Make commits of logical units. - - - - If you removed pkgs, made some major NixOS changes etc., write about them in nixos/doc/manual/release-notes/rl-unstable.xml. - - - + + + + + If you removed pkgs or made some major NixOS changes, write about it in the release notes for the next stable release. For example nixos/doc/manual/release-notes/rl-2003.xml. @@ -178,7 +171,7 @@ Additional information. - Rebase you branch against current master. + Rebase your branch against current master. @@ -194,36 +187,12 @@ Additional information. - Create pull request: - - - - Write the title in format (pkg-name | nixos/<module>): improvement. - - - - If you update the pkg, write versions from -> to. - - - - - - - - Write in comment if you have tested your patch. Do not rely much on TravisCI. - - - - - If you make an improvement, write about your motivation. - - - - - Notify maintainers of the package. For example add to the message: cc @jagajaga @domenkozar. - - - + Create the pull request + + + + + Follow the contribution guidelines.