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

improve wording in contribution guide (#549)

Browse source 
* improve wording in contribution guide
This commit is contained in:
Valentin Gagarin 2023-05-16 00:41:00 +02:00 committed by GitHub
parent 3d23d36bc6
commit 3c857b4589
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 39 additions and 48 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -1,77 +1,68 @@
# How to Contribute # How to contribute
This guide explains how you can contribute to Nix, Nix packages or The Nix ecosystem is developed by many volunteers and a few paid developers, maintaining one of the largest open source software distributions in the world.
NixOS. Keeping it working and up to date would not be possible without your support.
:::{note} This guide shows how you can contribute to {term}`Nix`, {term}`Nixpkgs` or {term}`NixOS`.
Please also consider [contributing documentation](./documentation.md).
## Getting started
[Join our community communication platforms](https://nixos.org/community) to get in contact with other users and developers.
Check out our [community teams](https://nixos.org/community/#governance-teams) if you're interested in a particular topic.
All the source code and documentation is on [GitHub](https://github.com/), and you need a GitHub account to propose changes.
Technical discussions happen in issue and pull request comments.
:::{tip}
If you are new to Nix, consider [contributing documentation](./documentation.md) first.
This is where we need the most help and where it is the easiest to begin.
::: :::
## Report an issue ## Report an issue
We can only fix issues that we know of, so please report any issue you We can only fix issues that we know of, so please report any issue you encounter.
encounter.
Issues with the **package manager Nix** (including its documentation) Issues with {term}`Nix` (including the [Nix reference manual](https://nixos.org/manual/nix/stable)) are reported at <https://github.com/NixOS/nix/issues>.
are reported at <https://github.com/NixOS/nix/issues>.
Issues with **specific packages or NixOS** (including its modules and Issues with {term}`Nixpkgs` or {term}`NixOS` (including packages, configuration modules, the [Nixpkgs manual](https://nixos.org/manual/nixpkgs/stable), and the [NixOS manual](https://nixos.org/manual/nixos/stable)) are reported at <https://github.com/NixOS/nixpkgs/issues>.
documentation) are reported at <https://github.com/NixOS/nixpkgs/issues>.
Make sure that there is not already an open issue for your problem. Make sure that there is not already an open issue for your problem.
Please follow the issue template and fill in all requested information Please follow the issue template and fill in all requested information.
as they help us solve the problem.
You need a [GitHub] account for that.
[github]: https://github.com/
## Contribute to Nix ## Contribute to Nix
The package manager Nix is mostly written in C++. Nix is the cornerstone of the ecosystem, and is mostly written in C++.
If you want to contribute to its development, you can find 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.
information on [how to setup a development environment] in the manual.
You can find inspiration for things to improve on the [issue tracker][nix issues]. [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.
Feel free to [join our community] to get in 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.
contact with other developers.
[how to setup a development environment]: https://nixos.org/manual/nix/unstable/contributing/hacking.html
[nix issues]: https://github.com/NixOS/nix/issues
[join our community]: https://nixos.org/community
## Contribute to Nixpkgs ## Contribute to Nixpkgs
Packaging for Nix is simple when you have understood the basic concept. Contributing to {term}`Nixpkgs` is simple when you have understood the basic concepts.
[The Nixpkgs manual][nixpkgs quick-start] explains step-by-step how to add new packages to [The Nixpkgs manual quick start guide][https://nixos.org/manual/nixpkgs/stable/#chap-quick-start] explains step-by-step how to add new packages.
the Nix package collection. There are also [programming language specific instructions]. There are also [programming-language-specific instructions](https://nixos.org/manual/nixpkgs/stable/#chap-language-support).
You can find inspiration for things to improve in the [reported issues][nixpkgs issues]. You can find inspiration for things to improve in the [Nixpkgs issue tracker][nixpkgs issues].
[nixpkgs quick-start]: https://nixos.org/manual/nixpkgs/stable/#chap-quick-start [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
[programming language specific instructions]: https://nixos.org/manual/nixpkgs/stable/#chap-language-support
[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
## Contribute to NixOS ## Contribute to NixOS
It’s pretty easy to contribute to NixOS compared to other linux It’s pretty easy to contribute to NixOS compared to other Linux distributions.
distributions. All the code is on GitHub in the repository [nixpkgs]. All the code is on GitHub in the [`nixpkgs`] repository.
Everyone can propose an improvement and most of them get merged after a Everyone can propose an improvement and most of them get merged after a review by maintainers.
review of the maintainers. You will get feedback in the pull request. You will get feedback in the pull request.
See the [NixOS manual][nixos manual dev] to get started and find all the details. See the [NixOS manual's development section](https://nixos.org/manual/nixos/stable/index.html#ch-development) to get started.
You can find inspiration for things to improve in the [reported issues][nixos issues]. [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.
If you know your way around, working on [popular issues][nixos issues] will be highly appreciated by other NixOS users.
There are also [issues tagged with good-first-bug] that are a good start for new [`nixpkgs`]: https://github.com/NixOS/nixpkgs
contributors. [nixos issues]: https://github.com/NixOS/nixpkgs/issues?q=is%3Aopen+is%3Aissue+label%3A%226.topic%3A+nixos%22+sort%3Areactions-%2B1-desc
Feel free to [join our community] of developers!
[nixpkgs]: https://github.com/NixOS/nixpkgs
[nixos manual dev]: https://nixos.org/manual/nixos/stable/index.html#ch-development
[nixos issues]: https://github.com/NixOS/nixpkgs/issues?q=is%3Aopen+is%3Aissue+label%3A%226.topic%3A+nixos%22
[issues tagged with good-first-bug]: https://github.com/NixOS/nixpkgs/labels/3.skill%3A%20good-first-bug