diff options
Diffstat (limited to 'nixpkgs/doc/contributing')
6 files changed, 211 insertions, 0 deletions
diff --git a/nixpkgs/doc/contributing/coding-conventions.chapter.md b/nixpkgs/doc/contributing/coding-conventions.chapter.md new file mode 100644 index 000000000000..3afa6140c6cd --- /dev/null +++ b/nixpkgs/doc/contributing/coding-conventions.chapter.md @@ -0,0 +1,63 @@ +# Coding conventions {#chap-conventions} + +This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md). + +## Syntax {#sec-syntax} + +This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md). + +## Package naming {#sec-package-naming} + +This section has been moved to [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md). + +## File naming and organisation {#sec-organisation} + +This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md). + +### Versioning {#sec-versioning} + +This section has been moved to [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md). + +## Fetching Sources {#sec-sources} + +This section has been moved to [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md). + +## Obtaining source hash {#sec-source-hashes} + +This section has been moved to [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md). + +### Obtaining hashes securely {#sec-source-hashes-security} + +This section has been moved to [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md). + +## Patches {#sec-patches} + +This section has been moved to [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md). + +## Package tests {#sec-package-tests} + +This section has been moved to [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md). + +### Writing inline package tests {#ssec-inline-package-tests-writing} + +This section has been moved to [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md). + +### Writing larger package tests {#ssec-package-tests-writing} + +This section has been moved to [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md). + +### Running package tests {#ssec-package-tests-running} + +This section has been moved to [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md). + +### Examples of package tests {#ssec-package-tests-examples} + +This section has been moved to [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md). + +### Linking NixOS module tests to a package {#ssec-nixos-tests-linking} + +This section has been moved to [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md). + +### Import From Derivation {#ssec-import-from-derivation} + +This section has been moved to [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md). diff --git a/nixpkgs/doc/contributing/contributing-to-documentation.chapter.md b/nixpkgs/doc/contributing/contributing-to-documentation.chapter.md new file mode 100644 index 000000000000..777858b901c3 --- /dev/null +++ b/nixpkgs/doc/contributing/contributing-to-documentation.chapter.md @@ -0,0 +1,11 @@ +# Contributing to Nixpkgs documentation {#chap-contributing} + +This section has been moved to [doc/README.md](https://github.com/NixOS/nixpkgs/blob/master/doc/README.md). + +## devmode {#sec-contributing-devmode} + +This section has been moved to [doc/README.md](https://github.com/NixOS/nixpkgs/blob/master/doc/README.md). + +## Syntax {#sec-contributing-markup} + +This section has been moved to [doc/README.md](https://github.com/NixOS/nixpkgs/blob/master/doc/README.md). diff --git a/nixpkgs/doc/contributing/quick-start.chapter.md b/nixpkgs/doc/contributing/quick-start.chapter.md new file mode 100644 index 000000000000..e482de7bc7b0 --- /dev/null +++ b/nixpkgs/doc/contributing/quick-start.chapter.md @@ -0,0 +1,3 @@ +# Quick Start to Adding a Package {#chap-quick-start} + +This section has been moved to [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md). diff --git a/nixpkgs/doc/contributing/reviewing-contributions.chapter.md b/nixpkgs/doc/contributing/reviewing-contributions.chapter.md new file mode 100644 index 000000000000..c291ef5b1293 --- /dev/null +++ b/nixpkgs/doc/contributing/reviewing-contributions.chapter.md @@ -0,0 +1,35 @@ +# Reviewing contributions {#chap-reviewing-contributions} + +This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md). + +## Package updates {#reviewing-contributions-package-updates} + +This section has been moved to [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md). + +## New packages {#reviewing-contributions-new-packages} + +This section has been moved to [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md). + +## Module updates {#reviewing-contributions-module-updates} + +This section has been moved to [nixos/README.md](https://github.com/NixOS/nixpkgs/blob/master/nixos/README.md). + +## New modules {#reviewing-contributions-new-modules} + +This section has been moved to [nixos/README.md](https://github.com/NixOS/nixpkgs/blob/master/nixos/README.md). + +## Individual maintainer list {#reviewing-contributions-individual-maintainer-list} + +This section has been moved to [maintainers/README.md](https://github.com/NixOS/nixpkgs/blob/master/maintainers/README.md). + +## Maintainer teams {#reviewing-contributions-maintainer-teams} + +This section has been moved to [maintainers/README.md](https://github.com/NixOS/nixpkgs/blob/master/maintainers/README.md). + +## Other submissions {#reviewing-contributions-other-submissions} + +This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md). + +## Merging pull requests {#reviewing-contributions--merging-pull-requests} + +This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md). diff --git a/nixpkgs/doc/contributing/submitting-changes.chapter.md b/nixpkgs/doc/contributing/submitting-changes.chapter.md new file mode 100644 index 000000000000..d47a5359779e --- /dev/null +++ b/nixpkgs/doc/contributing/submitting-changes.chapter.md @@ -0,0 +1,88 @@ +# Submitting changes {#chap-submitting-changes} + +This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md). + +## Submitting changes {#submitting-changes-submitting-changes} + +This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md). + +## Submitting security fixes {#submitting-changes-submitting-security-fixes} + +This section has been moved to [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md). + +## Deprecating/removing packages {#submitting-changes-deprecating-packages} + +This section has been moved to [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md). + +### Steps to remove a package from Nixpkgs {#steps-to-remove-a-package-from-nixpkgs} + +This section has been moved to [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md). + +## Pull Request Template {#submitting-changes-pull-request-template} + +This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md). + +### Tested using sandboxing {#submitting-changes-tested-with-sandbox} + +This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md). + +### Built on platform(s) {#submitting-changes-platform-diversity} + +This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md). + +### Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests) {#submitting-changes-nixos-tests} + +This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md). + +### Tested compilation of all pkgs that depend on this change using `nixpkgs-review` {#submitting-changes-tested-compilation} + +This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md). + +### Tested execution of all binary files (usually in `./result/bin/`) {#submitting-changes-tested-execution} + +This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md). + +### Meets Nixpkgs contribution standards {#submitting-changes-contribution-standards} + +This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md). + +## Hotfixing pull requests {#submitting-changes-hotfixing-pull-requests} + +This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md). + +## Commit policy {#submitting-changes-commit-policy} + +This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md). + +### Branches {#submitting-changes-branches} + +This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md). + +#### Master branch {#submitting-changes-master-branch} + +This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md). + +#### Staging branch {#submitting-changes-staging-branch} + +This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md). + +#### Staging-next branch {#submitting-changes-staging-next-branch} + +This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md). + +#### Stable release branches {#submitting-changes-stable-release-branches} + +This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md). + +#### Automatically backporting a Pull Request {#submitting-changes-stable-release-branches-automatic-backports} + +This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md). + +#### Manually backporting changes {#submitting-changes-stable-release-branches-manual-backports} + +This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md). + +#### Acceptable backport criteria {#acceptable-backport-criteria} + +This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md). + diff --git a/nixpkgs/doc/contributing/vulnerability-roundup.chapter.md b/nixpkgs/doc/contributing/vulnerability-roundup.chapter.md new file mode 100644 index 000000000000..0880fecea982 --- /dev/null +++ b/nixpkgs/doc/contributing/vulnerability-roundup.chapter.md @@ -0,0 +1,11 @@ +# Vulnerability Roundup {#chap-vulnerability-roundup} + +This section has been moved to [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md). + +## Issues {#vulnerability-roundup-issues} + +This section has been moved to [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md). + +## Triaging and Fixing {#vulnerability-roundup-triaging-and-fixing} + +This section has been moved to [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md). |