diff options
Diffstat (limited to 'nixpkgs/.github')
| -rw-r--r-- | nixpkgs/.github/CODEOWNERS | 152 | ||||
| -rw-r--r-- | nixpkgs/.github/CONTRIBUTING.md | 54 | ||||
| -rw-r--r-- | nixpkgs/.github/ISSUE_TEMPLATE.md | 11 | ||||
| -rw-r--r-- | nixpkgs/.github/ISSUE_TEMPLATE/bug_report.md | 37 | ||||
| -rw-r--r-- | nixpkgs/.github/ISSUE_TEMPLATE/packaging_request.md | 18 | ||||
| -rw-r--r-- | nixpkgs/.github/PULL_REQUEST_TEMPLATE.md | 23 |
6 files changed, 295 insertions, 0 deletions
diff --git a/nixpkgs/.github/CODEOWNERS b/nixpkgs/.github/CODEOWNERS new file mode 100644 index 000000000000..58834f4597e5 --- /dev/null +++ b/nixpkgs/.github/CODEOWNERS @@ -0,0 +1,152 @@ +# CODEOWNERS file +# +# This file is used to describe who owns what in this repository. This file does not +# replace `meta.maintainers` but is instead used for other things than derivations +# and modules, like documentation, package sets, and other assets. +# +# For documentation on this file, see https://help.github.com/articles/about-codeowners/ +# Mentioned users will get code review requests. + +# This file +/.github/CODEOWNERS @edolstra + +# Libraries +/lib @edolstra @nbp +/lib/systems @nbp @ericson2314 @matthewbauer +/lib/generators.nix @edolstra @nbp @Profpatsch +/lib/debug.nix @edolstra @nbp @Profpatsch + +# Nixpkgs Internals +/default.nix @nbp +/pkgs/top-level/default.nix @nbp @Ericson2314 +/pkgs/top-level/impure.nix @nbp @Ericson2314 +/pkgs/top-level/stage.nix @nbp @Ericson2314 @matthewbauer +/pkgs/top-level/splice.nix @Ericson2314 @matthewbauer +/pkgs/top-level/release-cross.nix @Ericson2314 @matthewbauer +/pkgs/stdenv/generic @Ericson2314 @matthewbauer +/pkgs/stdenv/cross @Ericson2314 @matthewbauer +/pkgs/build-support/cc-wrapper @Ericson2314 @orivej +/pkgs/build-support/bintools-wrapper @Ericson2314 @orivej +/pkgs/build-support/setup-hooks @Ericson2314 + +# NixOS Internals +/nixos/default.nix @nbp +/nixos/lib/from-env.nix @nbp +/nixos/lib/eval-config.nix @nbp +/nixos/doc/manual/configuration/abstractions.xml @nbp +/nixos/doc/manual/configuration/config-file.xml @nbp +/nixos/doc/manual/configuration/config-syntax.xml @nbp +/nixos/doc/manual/configuration/modularity.xml @nbp +/nixos/doc/manual/development/assertions.xml @nbp +/nixos/doc/manual/development/meta-attributes.xml @nbp +/nixos/doc/manual/development/option-declarations.xml @nbp +/nixos/doc/manual/development/option-def.xml @nbp +/nixos/doc/manual/development/option-types.xml @nbp +/nixos/doc/manual/development/replace-modules.xml @nbp +/nixos/doc/manual/development/writing-modules.xml @nbp +/nixos/doc/manual/man-nixos-option.xml @nbp +/nixos/modules/installer/tools/nixos-option.sh @nbp + +# New NixOS modules +/nixos/modules/module-list.nix @Infinisil + +# Python-related code and docs +/maintainers/scripts/update-python-libraries @FRidh +/pkgs/top-level/python-packages.nix @FRidh +/pkgs/development/interpreters/python @FRidh +/pkgs/development/python-modules @FRidh +/doc/languages-frameworks/python.section.md @FRidh + +# Haskell +/pkgs/development/compilers/ghc @basvandijk +/pkgs/development/haskell-modules @basvandijk +/pkgs/development/haskell-modules/default.nix @basvandijk +/pkgs/development/haskell-modules/generic-builder.nix @basvandijk +/pkgs/development/haskell-modules/hoogle.nix @basvandijk + +# Perl +/pkgs/development/interpreters/perl @volth +/pkgs/top-level/perl-packages.nix @volth +/pkgs/development/perl-modules @volth + +# R +/pkgs/applications/science/math/R @peti +/pkgs/development/r-modules @peti + +# Ruby +/pkgs/development/interpreters/ruby @alyssais @zimbatm +/pkgs/development/ruby-modules @alyssais @zimbatm + +# Rust +/pkgs/development/compilers/rust @Mic92 @LnL7 + +# Darwin-related +/pkgs/stdenv/darwin @NixOS/darwin-maintainers +/pkgs/os-specific/darwin @NixOS/darwin-maintainers + +# C compilers +/pkgs/development/compilers/gcc @matthewbauer +/pkgs/development/compilers/llvm @matthewbauer + +# Compatibility stuff +/pkgs/top-level/unix-tools.nix @matthewbauer +/pkgs/development/tools/xcbuild @matthewbauer + +# Beam-related (Erlang, Elixir, LFE, etc) +/pkgs/development/beam-modules @gleber +/pkgs/development/interpreters/erlang @gleber +/pkgs/development/interpreters/lfe @gleber +/pkgs/development/interpreters/elixir @gleber +/pkgs/development/tools/build-managers/rebar @gleber +/pkgs/development/tools/build-managers/rebar3 @gleber +/pkgs/development/tools/erlang @gleber + +# Jetbrains +/pkgs/applications/editors/jetbrains @edwtjo + +# Eclipse +/pkgs/applications/editors/eclipse @rycee + +# Licenses +/lib/licenses.nix @alyssais + +# Qt / KDE +/pkgs/applications/kde @ttuegel +/pkgs/desktops/plasma-5 @ttuegel +/pkgs/development/libraries/kde-frameworks @ttuegel +/pkgs/development/libraries/qt-5 @ttuegel + +# PostgreSQL and related stuff +/pkgs/servers/sql/postgresql @thoughtpolice +/nixos/modules/services/databases/postgresql.xml @thoughtpolice +/nixos/modules/services/databases/postgresql.nix @thoughtpolice +/nixos/tests/postgresql.nix @thoughtpolice + +# Hardened profile & related modules +/nixos/modules/profiles/hardened.nix @joachifm +/nixos/modules/security/hidepid.nix @joachifm +/nixos/modules/security/lock-kernel-modules.nix @joachifm +/nixos/modules/security/misc.nix @joachifm +/nixos/tests/hardened.nix @joachifm +/pkgs/os-specific/linux/kernel/hardened-config.nix @joachifm + +# Dhall +/pkgs/development/dhall-modules @Gabriel439 @Profpatsch +/pkgs/development/interpreters/dhall @Gabriel439 @Profpatsch + +# Idris +/pkgs/development/idris-modules @Infinisil + +# Bazel +/pkgs/development/tools/build-managers/bazel @mboes @Profpatsch + +# NixOS modules for e-mail and dns services +/nixos/modules/services/mail/mailman.nix @peti +/nixos/modules/services/mail/postfix.nix @peti +/nixos/modules/services/networking/bind.nix @peti +/nixos/modules/services/mail/rspamd.nix @peti + +# Emacs +/pkgs/applications/editors/emacs-modes @adisbladis +/pkgs/applications/editors/emacs @adisbladis +/pkgs/top-level/emacs-packages.nix @adisbladis diff --git a/nixpkgs/.github/CONTRIBUTING.md b/nixpkgs/.github/CONTRIBUTING.md new file mode 100644 index 000000000000..07eddc80c253 --- /dev/null +++ b/nixpkgs/.github/CONTRIBUTING.md @@ -0,0 +1,54 @@ +# How to contribute + +Note: contributing implies licensing those contributions +under the terms of [COPYING](../COPYING), which is an MIT-like license. + +## Opening issues + +* Make sure you have a [GitHub account](https://github.com/signup/free) +* [Submit an issue](https://github.com/NixOS/nixpkgs/issues) - assuming one does not already exist. + * Clearly describe the issue including steps to reproduce when it is a bug. + * Include information what version of nixpkgs and Nix are you using (nixos-version or git revision). + +## Submitting changes + +* Format the commit messages in the following way: + + ``` + (pkg-name | nixos/<module>): (from -> to | init at version | refactor | etc) + + (Motivation for change. Additional information.) + ``` + + For consistency, there should not be a period at the end of the commit message's summary line (the first line of the commit message). + + Examples: + + * nginx: init at 2.0.1 + * firefox: 54.0.1 -> 55.0 + * nixos/hydra: add bazBaz option + + Dual baz behavior is needed to do foo. + * nixos/nginx: refactor config generation + + 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 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 + +In addition to writing properly formatted commit messages, it's important to include relevant information so other developers can later understand *why* a change was made. While this information usually can be found by digging code, mailing list/Discourse archives, pull request discussions or upstream changes, it may require a lot of work. + +For package version upgrades and such a one-line commit message is usually sufficient. + +## Reviewing contributions + +See the nixpkgs manual for more details on how to [Review contributions](https://nixos.org/nixpkgs/manual/#sec-reviewing-contributions). diff --git a/nixpkgs/.github/ISSUE_TEMPLATE.md b/nixpkgs/.github/ISSUE_TEMPLATE.md new file mode 100644 index 000000000000..d7463385ae58 --- /dev/null +++ b/nixpkgs/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,11 @@ +## Issue description + + + +### Steps to reproduce + + + +## Technical details + +Please run `nix run nixpkgs.nix-info -c nix-info -m` and paste the result. diff --git a/nixpkgs/.github/ISSUE_TEMPLATE/bug_report.md b/nixpkgs/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 000000000000..8cc9a80758d3 --- /dev/null +++ b/nixpkgs/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,37 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '0.kind: bug' +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. ... +2. ... +3. ... + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Additional context** +Add any other context about the problem here. + +**Metadata** +Please run `nix run nixpkgs.nix-info -c nix-info -m` and paste the result. + +Maintainer information: +```yaml +# a list of nixpkgs attributes affected by the problem +attribute: +# a list of nixos modules affected by the problem +module: +``` diff --git a/nixpkgs/.github/ISSUE_TEMPLATE/packaging_request.md b/nixpkgs/.github/ISSUE_TEMPLATE/packaging_request.md new file mode 100644 index 000000000000..1ddcd983f31b --- /dev/null +++ b/nixpkgs/.github/ISSUE_TEMPLATE/packaging_request.md @@ -0,0 +1,18 @@ +--- +name: Packaging requests +about: For packages that are missing +title: '' +labels: '0.kind: packaging request' +assignees: '' + +--- + +**Project description** +_describe the project a little_ + +**Metadata** + +* homepage URL: +* source URL: +* license: mit, bsd, gpl2+ , ... +* platforms: unix, linux, darwin, ... diff --git a/nixpkgs/.github/PULL_REQUEST_TEMPLATE.md b/nixpkgs/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000000..a4f1c61e8f59 --- /dev/null +++ b/nixpkgs/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,23 @@ +<!-- Nixpkgs has a lot of new incoming Pull Requests, but not enough people to review this constant stream. Even if you aren't a committer, we would appreciate reviews of other PRs, especially simple ones like package updates. Just testing the relevant package/service and leaving a comment saying what you tested, how you tested it and whether it worked would be great. List of open PRs: <https://github.com/NixOS/nixpkgs/pulls>, for more about reviewing contributions: <https://hydra.nixos.org/job/nixpkgs/trunk/manual/latest/download/1/nixpkgs/manual.html#sec-reviewing-contributions>. Reviewing isn't mandatory, but it would help out a lot and reduce the average time-to-merge for all of us. Thanks a lot if you do! --> +###### Motivation for this change + + +###### Things done + +<!-- Please check what applies. Note that these are not hard requirements but merely serve as information for reviewers. --> + +- [ ] Tested using sandboxing ([nix.useSandbox](http://nixos.org/nixos/manual/options.html#opt-nix.useSandbox) on NixOS, or option `sandbox` in [`nix.conf`](http://nixos.org/nix/manual/#sec-conf-file) on non-NixOS) +- Built on platform(s) + - [ ] NixOS + - [ ] macOS + - [ ] other Linux distributions +- [ ] Tested via one or more NixOS test(s) if existing and applicable for the change (look inside [nixos/tests](https://github.com/NixOS/nixpkgs/blob/master/nixos/tests)) +- [ ] Tested compilation of all pkgs that depend on this change using `nix-shell -p nix-review --run "nix-review wip"` +- [ ] Tested execution of all binary files (usually in `./result/bin/`) +- [ ] Determined the impact on package closure size (by running `nix path-info -S` before and after) +- [ ] Ensured that relevant documentation is up to date +- [ ] Fits [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/.github/CONTRIBUTING.md). + +###### Notify maintainers + +cc @ |