From 857f57ffd8202674eeaf602004a987c32efc0773 Mon Sep 17 00:00:00 2001 From: Anderson Torres Date: Fri, 11 Aug 2023 21:36:42 -0300 Subject: [PATCH] CONTRIBUTING.md: highlight the need for setting `meta.mainProgram` --- CONTRIBUTING.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f318f19ead39..0734db52129f 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).