diff options
| author | AndersonTorres <torres.anderson.85@protonmail.com> | 2022-12-31 12:08:09 -0300 |
|---|---|---|
| committer | AndersonTorres <torres.anderson.85@protonmail.com> | 2022-12-31 12:12:50 -0300 |
| commit | 5b86dce808df2c7053223c43c6241ccf365f321c (patch) | |
| tree | 625f1817b087452116d92dbb7b9a64362abd4173 /CONTRIBUTING.md | |
| parent | 27a3fda9e86e67142c33be91f40d91f8f8fda3b2 (diff) | |
CONTRIBUTING.md: clarify some directives about `meta` attributes
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c6bc661c72b66..19108bb5a8fb6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -38,11 +38,14 @@ 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: + * Be short, just one sentence. * Be capitalized. * Not start with the package name. - * Not have a period at the end. + * More generally, it should not refer to the package name. + * Not end with a period (or any punctuation for that matter). * `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. See the nixpkgs manual for more details on [standard meta-attributes](https://nixos.org/nixpkgs/manual/#sec-standard-meta-attributes). |