summary refs log tree commit diff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorAnderson Torres <torres.anderson.85@protonmail.com>2023-08-11 21:36:42 -0300
committerAnderson Torres <torres.anderson.85@protonmail.com>2023-08-12 23:00:15 +0000
commit857f57ffd8202674eeaf602004a987c32efc0773 (patch)
tree7745f0bddd5b2a7137ffa2021d1accae60c12747 /CONTRIBUTING.md
parent64222deb8b5bb4b39fdd9ca82bb44f6b3672ab8d (diff)
downloadnixpkgs-857f57ffd8202674eeaf602004a987c32efc0773.tar
nixpkgs-857f57ffd8202674eeaf602004a987c32efc0773.tar.gz
nixpkgs-857f57ffd8202674eeaf602004a987c32efc0773.tar.bz2
nixpkgs-857f57ffd8202674eeaf602004a987c32efc0773.tar.lz
nixpkgs-857f57ffd8202674eeaf602004a987c32efc0773.tar.xz
nixpkgs-857f57ffd8202674eeaf602004a987c32efc0773.tar.zst
nixpkgs-857f57ffd8202674eeaf602004a987c32efc0773.zip
CONTRIBUTING.md: highlight the need for setting `meta.mainProgram`
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md5
1 files changed, 3 insertions, 2 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index f318f19ead3..0734db52129 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -37,7 +37,7 @@ Below is a short excerpt of some points in there:
 
     The old config generation system used impure shell scripts and could break in specific circumstances (see #1234).
 
-* `meta.description` should:
+* `meta.description` must:
   * Be short, just one sentence.
   * Be capitalized.
   * Not start with the package name.
@@ -47,7 +47,8 @@ Below is a short excerpt of some points in there:
 * `meta.license` must be set and fit the upstream license.
   * If there is no upstream license, `meta.license` should default to `lib.licenses.unfree`.
   * If in doubt, try to contact the upstream developers for clarification.
-* `meta.maintainers` must be set.
+* `meta.mainProgram` must be set when appropriate.
+* `meta.maintainers` should be set.
 
 See the nixpkgs manual for more details on [standard meta-attributes](https://nixos.org/nixpkgs/manual/#sec-standard-meta-attributes).