Contributing: Difference between revisions

From NixOS Wiki
imported>Winny
Patka (talk | contribs)
Clean a few sentences and add/update links.
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.}}
{{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.}}
= Welcome =
There are many ways to contribute to NixOS and Nix at large.  Please read on to learn how to contribute to the mission.


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


Development of [[Nix Package Manager|Nix]] and [[NixOS]] happens primarily on [[Nixpkgs]]. You can contribute by helping reporting, diagnosing and closing issues, by creating, testing and reviewing pull-requests, and 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]].
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]].


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 ML.
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]].
See also [[Contributing to nixpkgs]].
Line 15: Line 11:
=== Alternative: Contribute to Nix User Repositories===
=== Alternative: Contribute to Nix User Repositories===


In the case your packages were not accepted by 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 in the case your packages have issues noticed by another user.
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 ==
 
See the [https://github.com/NixOS/nix/blob/master/CONTRIBUTING.md Nix repository contribution guide].


== Contributing to the documentation ==
== Contributing to the documentation ==
Line 22: Line 22:


== Contributing to this Wiki ==
== Contributing to this Wiki ==
 
See [[NixOS Wiki:Contributing]]. Feel free to join the [https://matrix.to/#/#wiki:nixos.org #wiki channel on Matrix] for questions.
Development of the wiki and other community initiatives happens at at the [https://github.com/nix-community nix-community Github repository]. The [https://matrix.to/#/#nixos-wiki:utzutzutz.net #nixos-wiki channel on Matrix] is available for questions.
 
See [[NixOS Wiki:Contributing]]


== Support other users ==
== Support other users ==


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:
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:


* Help users on the Nix Discourse.
* Help users on the [https://discourse.nixos.org/ Nix Discourse].
* Help users on the Nix Matrix (real time chat).
* 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 or NixOS.
* Write blog posts on how to do things with Nix(OS).
* Engage with others on social media about Nix or NixOS.
* Engage with others on social media about Nix(OS).




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

Revision as of 20:30, 8 April 2024

Contributing packages to nixpkgs

Development of 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 the contributing section of the Nixpkgs article.

There is also a 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

See the Nix repository contribution guide.

Contributing to the documentation

See Contributing to Nix documentation.

Contributing to this Wiki

See NixOS Wiki:Contributing. Feel free to join the #wiki channel on Matrix for questions.

Support other users

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:

  • Help users on the Nix Discourse.
  • Help users on the Nix Matrix (real time chat). Consider joining a 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).


Category:Contributing