CONTRIBUTING.md: mention that the meta.license and meta.maintainers attributes must be set #29668
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation for this change
So I've been reviewing a few PRs recently and I found that it's actually fairly common for these attributes to be left out (for PRs adding new packages). I know that CONTRIBUTING.md already has a link to the nixpkgs manual which mentions these attributes, but I felt that maybe these two lines could be added to CONTRIBUTING.md directly as well, seeing as though people seem to omit them from time to time?
The manual does say that a maintainer must be set, but I don't think the manual explicitly mentions that a license attribute must be set. However, even if the manual doesn't say a license must be set, I believe it's good form to require it for all packages (hence the line about
meta.license
), thoughts? For example, even if a package does not have a license, it can just be assumed to be nonfree (because I believe that's legally the case in basically all parts of the world?), and therefore have a license attributestdenv.lib.licenses.unfree
.Just to clarify, obviously
meta
attributes are optional, but I'm talking about when a package is to be added to this nixpkgs repository.Things done
build-use-sandbox
innix.conf
on non-NixOS)nix-shell -p nox --run "nox-review wip"
./result/bin/
)