swendel/nixpkgs
1
0
Fork 0
mirror of https://github.com/SebastianWendel/nixpkgs.git synced 2024-09-20 04:19:00 +02:00
Code Issues Packages Projects Releases Wiki Activity

CONTRIBUTING.md: highlight the need for setting meta.mainProgram

Browse source
This commit is contained in:
Anderson Torres 2023-08-11 21:36:42 -03:00
parent 64222deb8b
commit 857f57ffd8
1 changed files with 3 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
CONTRIBUTING.md
View file

@ -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).