From ef8c0b72abfc63b49115ed9cbd953bdb9624d9f0 Mon Sep 17 00:00:00 2001 From: fricklerhandwerk Date: Thu, 19 Oct 2023 12:17:00 +0200 Subject: [PATCH] refer to contributing guides in the respective projects this is where the information will be most up-to-date and where it should be maintained to begin with. --- source/contributing/how-to-contribute.md | 31 ++++++++++-------------- 1 file changed, 13 insertions(+), 18 deletions(-) diff --git a/source/contributing/how-to-contribute.md b/source/contributing/how-to-contribute.md index 77168cf..c0c77a4 100644 --- a/source/contributing/how-to-contribute.md +++ b/source/contributing/how-to-contribute.md @@ -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