Add section in CONTRIBUTING about documentation

ngi-nix · Aug 21, 2024 · c164743 · c164743
1 parent 3216573
commit c164743
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -21,6 +21,10 @@ However, there may be reasons speaking against that, including:
 
 In any case, it is encouraged to create a pull request to Nixpkgs, then to this repository, with a comment linking to the Nixpkgs pull request in the description and the Nix expressions.
 
+## Documentation style guide
+
+When contributing documentation, do not split lines at arbitrary character lengths.
+Instead, write one sentence per line, as this makes it easier to review changes.
 
 ## How to create pull requests to NGIpkgs