summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorMartin Weinelt <hexa@darmstadt.ccc.de>2023-11-14 13:16:25 +0100
committerMartin Weinelt <hexa@darmstadt.ccc.de>2023-11-14 13:16:34 +0100
commit3c336a1647ada0970b71284cceb601c3d79c2134 (patch)
treedea9a6a0eb8673bf86ce7d114b09688d11356a46 /doc
parent2605fad79520679232edcf4de591013d7b34b0a5 (diff)
parentbf744fe90419885eefced41b3e5ae442d732712d (diff)
downloadnixpkgs-3c336a1647ada0970b71284cceb601c3d79c2134.tar
nixpkgs-3c336a1647ada0970b71284cceb601c3d79c2134.tar.gz
nixpkgs-3c336a1647ada0970b71284cceb601c3d79c2134.tar.bz2
nixpkgs-3c336a1647ada0970b71284cceb601c3d79c2134.tar.lz
nixpkgs-3c336a1647ada0970b71284cceb601c3d79c2134.tar.xz
nixpkgs-3c336a1647ada0970b71284cceb601c3d79c2134.tar.zst
nixpkgs-3c336a1647ada0970b71284cceb601c3d79c2134.zip
Merge remote-tracking branch 'origin/master' into staging-next
Conflicts:
- pkgs/development/libraries/gdcm/default.nix
Diffstat (limited to 'doc')
-rw-r--r--doc/README.md21
-rw-r--r--doc/languages-frameworks/go.section.md2
2 files changed, 22 insertions, 1 deletions
diff --git a/doc/README.md b/doc/README.md
index 3f9aff1a38a..9dee2d30d73 100644
--- a/doc/README.md
+++ b/doc/README.md
@@ -114,3 +114,24 @@ pear
 watermelon
 :   green fruit with red flesh
 ```
+
+## Commit conventions
+
+- Make sure you read about the [commit conventions](../CONTRIBUTING.md#commit-conventions) common to Nixpkgs as a whole.
+
+- If creating a commit purely for documentation changes, format the commit message in the following way:
+
+  ```
+  doc: (documentation summary)
+
+  (Motivation for change, relevant links, additional information.)
+  ```
+
+  Examples:
+
+  * doc: update the kernel config documentation to use `nix-shell`
+  * doc: add information about `nix-update-script`
+
+    Closes #216321.
+
+- If the commit contains more than just documentation changes, follow the commit message format relevant for the rest of the changes.
diff --git a/doc/languages-frameworks/go.section.md b/doc/languages-frameworks/go.section.md
index 59856b92c9e..884ebcebf7f 100644
--- a/doc/languages-frameworks/go.section.md
+++ b/doc/languages-frameworks/go.section.md
@@ -20,7 +20,7 @@ In the following is an example expression using `buildGoModule`, the following a
 
   To obtain the actual hash, set `vendorHash = lib.fakeHash;` and run the build ([more details here](#sec-source-hashes)).
 - `proxyVendor`: Fetches (go mod download) and proxies the vendor directory. This is useful if your code depends on c code and go mod tidy does not include the needed sources to build or if any dependency has case-insensitive conflicts which will produce platform-dependent `vendorHash` checksums.
-- `modPostBuild`: Shell commands to run after the build of the goModules executes `go mod vendor`, and before calculating fixed output derivation's `vendorHash` (or `vendorSha256`). Note that if you change this attribute, you need to update `vendorHash` (or `vendorSha256`) attribute.
+- `modPostBuild`: Shell commands to run after the build of the goModules executes `go mod vendor`, and before calculating fixed output derivation's `vendorHash`. Note that if you change this attribute, you need to update `vendorHash` attribute.
 
 ```nix
 pet = buildGoModule rec {