From 2ce1e0b2cc287799138439d04dee78af425b5c01 Mon Sep 17 00:00:00 2001 From: Silvan Mosberger Date: Mon, 14 Aug 2023 18:27:14 +0200 Subject: [PATCH] CONTRIBUTING.md: Typos and formatting MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Fix sentence about meeting contributing standards - pkgs -> packages - Use emoji's because GitHub renders the :*: things weird sometimes - Move a dot Co-authored-by: Rémi NICOLE --- CONTRIBUTING.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 48bab29c589e..2154271a6412 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -189,7 +189,7 @@ It’s important to test any executables generated by a build when you change or #### Meets Nixpkgs contribution standards -The last checkbox is fits the guidelines in this `CONTRIBUTING.md` file. 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 about whether it fits the guidelines in this `CONTRIBUTING.md` file. This 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. ### Rebasing between branches (i.e. from master to staging) [rebase]: #rebasing-between-branches-ie-from-master-to-staging @@ -288,7 +288,7 @@ To manually create a backport pull request, follow [the standard pull request pr > **Warning** > Do not use the `nixos-YY.MM` branch, that is a branch pointing to the tested release channel commit -- Instead of making manually making and committing the changes, use [`git cherry-pick -x`](https://git-scm.com/docs/git-cherry-pick) for each commit from the pull request you'd like to backport. +- Instead of manually making and committing the changes, use [`git cherry-pick -x`](https://git-scm.com/docs/git-cherry-pick) for each commit from the pull request you'd like to backport. Either `git cherry-pick -x ` when the reason for the backport is obvious (such as minor versions, fixes, etc.), otherwise use `git cherry-pick -xe ` to add a reason for the backport to the commit message. Here is [an example](https://github.com/nixos/nixpkgs/commit/5688c39af5a6c5f3d646343443683da880eaefb8) of this. @@ -336,8 +336,8 @@ It is possible for community members that have enough knowledge and experience o In case the PR is stuck waiting for the original author to apply a trivial change (a typo, capitalisation change, etc.) and the author allowed the members -to modify the PR, consider applying it yourself. (or commit the existing review -suggestion) You should pay extra attention to make sure the addition doesn't go +to modify the PR, consider applying it yourself (or commit the existing review +suggestion). You should pay extra attention to make sure the addition doesn't go against the idea of the original PR and would not be opposed by the author.