jolheiser/nixpkgs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
b7c525806e
nixpkgs/pkgs
History
Silvan Mosberger b7c525806e CONTRIBUTING.md: Rough move to new contribution doc files 
No content was changed, new titles are wrapped with () to signal that
they will need to be decided on in a future commit.
2023-08-13 22:01:23 +02:00
..
applications Merge pull request #248906 from hellwolf/owncloud-client-4.2.0 2023-08-13 19:42:48 +02:00
build-support
common-updater
data Merge pull request #248858 from NickCao/v2ray-domain-list-community 2023-08-13 17:28:28 +02:00
desktops Merge pull request #247841 from uninsane/pr-cross-engrampaD 2023-08-13 20:41:59 +03:00
development Merge pull request #247674 from fabaff/autocommand-bump 2023-08-13 21:34:03 +02:00
games Merge pull request #248919 from r-ryantm/auto-update/unciv 2023-08-13 16:38:14 +02:00
misc
os-specific linuxPackages.nvidia_x11.settings: add mainProgram 2023-08-13 22:52:23 +08:00
pkgs-lib
servers Merge pull request #248903 from oddlama/fix-influxdb-cli-main-program 2023-08-13 17:09:05 +02:00
shells Merge pull request #248791 from r-ryantm/auto-update/zimfw 2023-08-13 15:23:14 +02:00
stdenv
test
tools Merge pull request #247475 from qowoz/nix217 2023-08-13 13:27:20 -04:00
top-level Merge pull request #247475 from qowoz/nix217 2023-08-13 13:27:20 -04:00
README.md CONTRIBUTING.md: Rough move to new contribution doc files 2023-08-13 22:01:23 +02:00

README.md

Contributing to Nixpkgs packages

(Conventions)

  • meta.description must:
    • Be short, just one sentence.
    • Be capitalized.
    • Not start with the package name.
      • More generally, it should not refer to the package name.
    • Not end with a period (or any punctuation for that matter).
    • Aim to inform while avoiding subjective language.
  • 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.mainProgram must be set when appropriate.
  • meta.maintainers should be set.

See the nixpkgs manual for more details on standard meta-attributes.

Testing changes

To run the main types of tests locally:

  • Run package-internal tests with nix-build --attr pkgs.PACKAGE.passthru.tests
  • Run NixOS tests with nix-build --attr nixosTest.NAME, where NAME is the name of the test listed in nixos/tests/all-tests.nix
  • Run global package tests with nix-build --attr tests.PACKAGE, where PACKAGE is the name of the test listed in pkgs/test/default.nix
  • See lib/tests/NAME.nix for instructions on running specific library tests