-
-
Notifications
You must be signed in to change notification settings - Fork 18.6k
Documentation: style guide for use of with #292468
Copy link
Copy link
Open
Labels
2.status: stalehttps://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.mdhttps://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md6.topic: best practicesDocumentation and discussion around best practices for Nixpkgs developmentDocumentation and discussion around best practices for Nixpkgs development9.needs: community feedbackThis needs feedback from more community members.This needs feedback from more community members.9.needs: documentationThis needs to be documented well.This needs to be documented well.
Metadata
Metadata
Assignees
Labels
2.status: stalehttps://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.mdhttps://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md6.topic: best practicesDocumentation and discussion around best practices for Nixpkgs developmentDocumentation and discussion around best practices for Nixpkgs development9.needs: community feedbackThis needs feedback from more community members.This needs feedback from more community members.9.needs: documentationThis needs to be documented well.This needs to be documented well.
Fields
Give feedbackNo fields configured for issues without a type.
Problem
i see a lot of
license = with licenses; [ mit ]in PRs recently.compared to the simpler
license = licenses.mit, this is both longer and more syntactically complex, taking longer to read for humans, and possibly longer to evaluate too.Proposal
this should be avoided for single-license packages (which is most of them).
this would not apply to
meta.maintainers, for the following reason:maintainersis plural, which implies a listi would be willing to write this into
pkgs/README.mdbut i'm not going to open a PR until i've gotten some feedback, it wouldn't make sense for me to single-handedly decide what the best practice is.Add a 👍 reaction to issues you find important.