Contributing: Difference between revisions

(27 intermediate revisions by 9 users not shown)

Line 1:

~~{{Expansion|Fill out all~~ possible ~~ways~~ to contribute to ~~NixOS/~~Nix ~~here. There's more to contributing than nixpkgs - such as supporting your fellow users or writing articles.}}~~

It is possible to contribute to Nix(OS) in different ways:

* Contributing to Nix

== Contributing ~~packages~~ to ~~nixpkgs ==~~

* [[Contributing#Contributing to Nixpkgs|Contributing to Nixpkgs]] (see below)

* Contributing to the documentation

~~Development of~~ [[Nix Package Manager|Nix]] and [[NixOS]] happens primarily on [[Nixpkgs]]. You can contribute by reporting, diagnosing and closing issues. By creating, testing and reviewing pull-requests. By becoming a maintainer of packages and modules hosted on the repository. For more information, see [[Nixpkgs#Contributing|~~the contributing section of the~~ Nixpkgs ~~article~~]].

* [[Help:Contributing|Contributing to the Official NixOS Wiki]] (see below)

~~There is also a [[nixpkgs-dev-ml|Maillinglist]] where you can submit patches if you prefer~~ to ~~submit patches via email. These will then be forwarded to [[Nixpkgs]] as a pull request by someone on~~ the ~~mailing list.~~

~~See also~~ [[Contributing to ~~nixpkgs]].~~

~~=== Alternative: Contribute to Nix User Repositories===~~

~~In case your package(s) don't fit within nixpkgs, you may consider creating your own [[Nix User Repository~~]] (~~NUR~~) ~~to share your work with others. This cuts down on maintenance costs among community members, and gives you a way to receive feedback from others.~~

== Contributing to Nix ==

Line 17:

Line 9:

See the [https://github.com/NixOS/nix/blob/master/CONTRIBUTING.md Nix repository contribution guide].

== Contributing to ~~the documentation~~ ==

== Contributing to Nixpkgs ==

:''See also: [[Nixpkgs/Contributing]]''

See [[Contributing ~~to Nix documentation~~]].

== Contributing to ~~this Wiki ==~~

Contributing to [https://github.com/NixOS/nixpkgs Nixpkgs], the package repository for the [https://nixos.org/ Nix package manager], helps maintain and improve the ecosystem of software available to Nix users.

~~See [~~[NixOS ~~Wiki:Contributing~~]~~]. Feel free to join~~ the [https://~~matrix.to/#/#wiki:~~nixos.org ~~#wiki channel on Matrix~~] ~~for questions~~.

~~== Support other users ==~~

* Guide on [https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md Contributing to the packages in Nixpkgs]

* Guide on [https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md Contributing to Nixpkgs] in general

Nix/~~NixOS is a community-led effort~~. ~~It is up to every participant to help each other learn and use~~ Nix ~~effectively~~. ~~Here are some ways to help other users:~~

== Contributing to the documentation ==

Reference documentation and learning materials for using Nix standalone are maintained on [https://nix.dev/ nix.dev] by the [https://github.com/nixos/nix.dev/tree/master/maintainers Nix documentation team].

* Help users on the [https://~~discourse~~.~~nixos.org~~/ ~~Nix Discourse~~].

See [https://nix.dev/contributing/documentation Contributing Documentation] for how you can help.

* Help users on the Nix Matrix (real time chat). Consider joining a [[MatrixRooms|Matrix room]] that matches your interest/expertise.

* Write blog posts on how ~~to do things with Nix(OS).~~

* Engage with others on social media about Nix(OS).

== Contributing to the Official NixOS Wiki ==

[[:~~Category~~:Contributing]]

Any [[Special:CreateAccount|registered account]] can contribute to the wiki either in the form of content, or changes to its infrastructure. Articles can be edited by adding new information, reformatting the existing one or updating outdated facts. The infrastructure is managed through the GitHub repository, and all proposals are discussed there. You can read more about this on the [[NixOS Wiki:Contributing to the wiki]] page.

@@ Line 1: / Line 1: @@
-{{Expansion|Fill out all possible ways to contribute to NixOS/Nix here.  There's more to contributing than nixpkgs - such as supporting your fellow users or writing articles.}}
+It is possible to contribute to Nix(OS) in different ways:
+* Contributing to Nix
-== Contributing packages to nixpkgs ==
+* [[Contributing#Contributing to Nixpkgs|Contributing to Nixpkgs]] (see below)
+* Contributing to the documentation
-Development of [[Nix Package Manager|Nix]] and [[NixOS]] happens primarily on [[Nixpkgs]]. You can contribute by reporting, diagnosing and closing issues. By creating, testing and reviewing pull-requests. By becoming a maintainer of packages and modules hosted on the repository. For more information, see [[Nixpkgs#Contributing|the contributing section of the Nixpkgs article]].
+* [[Help:Contributing|Contributing to the Official NixOS Wiki]] (see below)
-There is also a [[nixpkgs-dev-ml|Maillinglist]] where you can submit patches if you prefer to submit patches via email. These will then be forwarded to [[Nixpkgs]] as a pull request by someone on the mailing list.
-See also [[Contributing to nixpkgs]].
-=== Alternative: Contribute to Nix User Repositories===
-In case your package(s) don't fit within nixpkgs, you may consider creating your own [[Nix User Repository]] (NUR) to share your work with others. This cuts down on maintenance costs among community members, and gives you a way to receive feedback from others.
 == Contributing to Nix ==
@@ Line 17: / Line 9: @@
 See the [https://github.com/NixOS/nix/blob/master/CONTRIBUTING.md Nix repository contribution guide].
-== Contributing to the documentation ==
+== Contributing to Nixpkgs ==
+:''See also: [[Nixpkgs/Contributing]]'' <!--- TODO: import MediaWiki templates, such as See_also --->
-See [[Contributing to Nix documentation]].
-== Contributing to this Wiki ==
+Contributing to [https://github.com/NixOS/nixpkgs Nixpkgs], the package repository for the [https://nixos.org/ Nix package manager],  helps maintain and improve the ecosystem of software available to Nix users.
-See [[NixOS Wiki:Contributing]]. Feel free to join the [https://matrix.to/#/#wiki:nixos.org #wiki channel on Matrix] for questions.
-== Support other users ==
+* Guide on [https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md Contributing to the packages in Nixpkgs]
+* Guide on [https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md Contributing to Nixpkgs] in general
-Nix/NixOS is a community-led effort. It is up to every participant to help each other learn and use Nix effectively.  Here are some ways to help other users:
+== Contributing to the documentation ==
+Reference documentation and learning materials for using Nix standalone are maintained on [https://nix.dev/ nix.dev] by the [https://github.com/nixos/nix.dev/tree/master/maintainers Nix documentation team].
-* Help users on the [https://discourse.nixos.org/ Nix Discourse].
+See [https://nix.dev/contributing/documentation Contributing Documentation] for how you can help.
-* Help users on the Nix Matrix (real time chat). Consider joining a [[MatrixRooms|Matrix room]] that matches your interest/expertise.
-* Write blog posts on how to do things with Nix(OS).
-* Engage with others on social media about Nix(OS).
+== Contributing to the Official NixOS Wiki ==
+{{main|NixOS Wiki:Contributing to the wiki}}
-[[:Category:Contributing]]
+Any [[Special:CreateAccount|registered account]] can contribute to the wiki either in the form of content, or changes to its infrastructure. Articles can be edited by adding new information, reformatting the existing one or updating outdated facts. The infrastructure is managed through the GitHub repository, and all proposals are discussed there. You can read more about this on the [[NixOS Wiki:Contributing to the wiki]] page.