Contributing: Difference between revisions

From NixOS Wiki
imported>Winny
dedicated page on how to contribute
 
Dander (talk | contribs)
m edited for clarity
 
(26 intermediate revisions by 6 users not shown)
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 to the documentation
* [[Contributing#Contributing to the Official NixOS Wiki|Contributing to the Official NixOS Wiki]] (see below)
* [[Contributing#Contributing to Nixpkgs|Contributing to Nixpkgs]] (see below)


= Welcome =
== Contributing to Nix ==


There are many ways to contribute to NixOS and Nix at large.  Please read on to learn how to contribute to the mission.
See the [https://github.com/NixOS/nix/blob/master/CONTRIBUTING.md Nix repository contribution guide].


== Contributing packages to nixpkgs ==
== Contributing to Nixpkgs ==
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.


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]].
* 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


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.
== 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].


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


== Contributing Documentation ==
== Contributing to the Official NixOS Wiki ==


See [[Contributing to Nix documentation]].
=== Contributing to the content ===


== Contributing to this Wiki ==
* Read and adhere the NixOS [[Manual of Style]] to ensure consistency across the wiki.
* Consider browsing the [https://wiki.nixos.org/wiki/Special:SpecialPages Special Pages] directory which contains useful links for understanding the Wiki's structure and for finding things to improve or create.
* Join the relevant [[MatrixRooms|Matrix room]]


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.
=== Contributing to the infrastructure ===


See [[NixOS Wiki:Contributing]]
The configuration is hosted on [https://github.com/NixOS/nixos-wiki-infra/ GitHub]. Discussions take place there, as well as in the [[MatrixRooms|Matrix room]], and during the documentation team meetings, which are public.


[[Category:Development]]
[[Category:Contributions]]


[[:Category:Contributing]]
{{DEFAULTSORT:NixOS Contributor's Guide.}}

Latest revision as of 19:52, 3 November 2024

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

Contributing to Nix

See the Nix repository contribution guide.

Contributing to Nixpkgs

Contributing to Nixpkgs, the package repository for the Nix package manager, helps maintain and improve the ecosystem of software available to Nix users.

Contributing to the documentation

Reference documentation and learning materials for using Nix standalone are maintained on nix.dev by the Nix documentation team.

See Contributing Documentation for how you can help.

Contributing to the Official NixOS Wiki

Contributing to the content

  • Read and adhere the NixOS Manual of Style to ensure consistency across the wiki.
  • Consider browsing the Special Pages directory which contains useful links for understanding the Wiki's structure and for finding things to improve or create.
  • Join the relevant Matrix room

Contributing to the infrastructure

The configuration is hosted on GitHub. Discussions take place there, as well as in the Matrix room, and during the documentation team meetings, which are public.