diff options
| author | Joachim F <joachifm@users.noreply.github.com> | 2017-10-28 11:14:15 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-10-28 11:14:15 +0000 |
| commit | 37acc1a5df0159b3eaff174885ce6463f89c213a (patch) | |
| tree | 623594bc18766099039be0bbbe40cdf232282ebd /.github | |
| parent | 330b4336bd9ecdf22b061bad353f70604230c445 (diff) | |
| parent | 4b25ecc7b8142155728422cbab4a68592e63f35d (diff) | |
| download | nixlib-37acc1a5df0159b3eaff174885ce6463f89c213a.tar nixlib-37acc1a5df0159b3eaff174885ce6463f89c213a.tar.gz nixlib-37acc1a5df0159b3eaff174885ce6463f89c213a.tar.bz2 nixlib-37acc1a5df0159b3eaff174885ce6463f89c213a.tar.lz nixlib-37acc1a5df0159b3eaff174885ce6463f89c213a.tar.xz nixlib-37acc1a5df0159b3eaff174885ce6463f89c213a.tar.zst nixlib-37acc1a5df0159b3eaff174885ce6463f89c213a.zip | |
Merge pull request #29668 from vyp/doc/contributing.md
CONTRIBUTING.md: mention that the meta.license and meta.maintainers attributes must be set
Diffstat (limited to '.github')
| -rw-r--r-- | .github/CONTRIBUTING.md | 13 |
1 files changed, 8 insertions, 5 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index f7fac647f412..41e85bd5ac46 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -32,11 +32,14 @@ under the terms of [COPYING](../COPYING), which is an MIT-like license. The old config generation system used impure shell scripts and could break in specific circumstances (see #1234). * `meta.description` should: - * Be capitalized - * Not start with the package name - * Not have a dot at the end - -See the nixpkgs manual for more details on how to [Submit changes to nixpkgs](https://nixos.org/nixpkgs/manual/#chap-submitting-changes). + * Be capitalized. + * Not start with the package name. + * Not have a period at the end. +* `meta.license` must be set and fit the upstream license. + * If there is no upstream license, `meta.license` should default to `stdenv.lib.licenses.unfree`. +* `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) and on how to [submit changes to nixpkgs](https://nixos.org/nixpkgs/manual/#chap-submitting-changes). ## Writing good commit messages |