NixOS/nix.dev
NixOS/nix.dev
1
0
Fork 0
mirror of https://github.com/NixOS/nix.dev.git synced 2024-10-18 14:32:43 -04:00
Code Activity

Merge pull request #766 from fricklerhandwerk/nix-contributing

Browse source 
refer to contributing guides in the respective projects
This commit is contained in:
Zach Mitchell, PhD 2023-10-19 22:42:16 -06:00 committed by GitHub
parent bdd2190e4e ef8c0b72ab
commit ad4fbfa565
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
source/contributing/how-to-contribute.md
View file

@ -74,37 +74,32 @@ Then the issue can be used to gauge user interest, to determine if the feature f
## Contribute to Nix
Nix is the cornerstone of the ecosystem, and is mostly written in C++.
{term}`Nix` is the cornerstone of the ecosystem, and is mostly written in C++.
If you want to contribute to its development, you can find information on [how to setup a development environment](https://nixos.org/manual/nix/unstable/contributing/hacking.html) in the manual.
[Issues tagged `good-first-issue`](https://github.com/NixOS/nix/issues?q=is%3Aopen+is%3Aissue+label%3Agood-first-issue) are a great opportunity for taking your first steps as a Nix contributor.
If you are proficient with C++, addressing one of the [popular issues](https://github.com/NixOS/nix/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc+label%3A%22idea+approved%22) will be highly appreciated by maintainers and Nix users all over the world.
If you want to help with development, check the [contributing guide in the Nix repository on GitHub](https://github.com/NixOS/nix/blob/master/CONTRIBUTING.md).
(contribute-nixpkgs)=
## Contribute to Nixpkgs
Contributing to {term}`Nixpkgs` is simple when you have understood the basic concepts.
[The Nixpkgs manual quick start guide](https://nixos.org/manual/nixpkgs/stable/#chap-quick-start) explains step-by-step how to add new packages.
There are also [programming-language-specific instructions](https://nixos.org/manual/nixpkgs/stable/#chap-language-support).
{term}`Nixpkgs` is a large software project with various areas of development.
You can find inspiration for things to improve in the [Nixpkgs issue tracker][nixpkgs issues].
[nixpkgs issues]: https://github.com/NixOS/nixpkgs/issues?q=is%3Aopen+is%3Aissue+-label%3A%226.topic%3A+nixos%22+-label%3A%226.topic%3A+module+system%22+-label%3A%226.+topic%3A+nixos-container%22+sort%3Areactions-%2B1-desc
If you want to help, start with the [contributing guide in the Nixpkgs repository on GitHub](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md) to get an overview of the code and the contribution process.
There are also [programming-language-specific instructions](https://nixos.org/manual/nixpkgs/unstable/#chap-language-support) for adding packages.
## Contribute to NixOS
It’s pretty easy to contribute to NixOS compared to other Linux distributions.
All the code is on GitHub in the [`nixpkgs`] repository.
Everyone can propose an improvement and most of them get merged after a review by maintainers.
You will get feedback in the pull request.
{term}`NixOS` is a collectively developed Linux distribution that can be configured conveniently in a highly flexible way through declarative programming interfaces.
The code for modules and default configurations is in the [`nixos` directory of the `nixpkgs` GitHub repository](https://github.com/NixOS/nixpkgs/tree/master/nixos).
See the [NixOS manual's development section](https://nixos.org/manual/nixos/stable/index.html#ch-development) to get started.
See the [NixOS manual's development section](https://nixos.org/manual/nixos/stable/index.html#ch-development) to get started with making improvements.
Contributor documentation specific to NixOS is still lacking, but most conventions for [Nixpkgs contributions](contribute-nixpkgs) apply.
Help with improving that is greatly appreciated.
[Issues tagged with `good-first-bug`](https://github.com/NixOS/nixpkgs/labels/3.skill%3A%20good-first-bug) are a good resource for new contributos.
Check [issues labeled `good-first-bug`](https://github.com/NixOS/nixpkgs/issues?q=is%3Aopen+label%3A%223.skill%3A+good-first-bug%22+label%3A%226.topic%3A+nixos%22) if you're a new contributor.
If you know your way around, working on [popular issues][nixos issues] will be highly appreciated by other NixOS users.
[`nixpkgs`]: https://github.com/NixOS/nixpkgs
[nixos issues]: https://github.com/NixOS/nixpkgs/issues?q=is%3Aopen+is%3Aissue+label%3A%226.topic%3A+nixos%22+sort%3Areactions-%2B1-desc