summary refs log tree commit diff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorSilvan Mosberger <silvan.mosberger@tweag.io>2023-08-02 20:30:42 +0200
committerSilvan Mosberger <silvan.mosberger@tweag.io>2023-08-13 22:04:57 +0200
commitecee8c3af416051cdde0d2dcdcaec644cda45b38 (patch)
tree62b9ebd6b91915358031d726d8c384f4e0991ffe /CONTRIBUTING.md
parent3d5fc07cfb6835d5928a1b3388dbbb5a2a61133e (diff)
downloadnixpkgs-ecee8c3af416051cdde0d2dcdcaec644cda45b38.tar
nixpkgs-ecee8c3af416051cdde0d2dcdcaec644cda45b38.tar.gz
nixpkgs-ecee8c3af416051cdde0d2dcdcaec644cda45b38.tar.bz2
nixpkgs-ecee8c3af416051cdde0d2dcdcaec644cda45b38.tar.lz
nixpkgs-ecee8c3af416051cdde0d2dcdcaec644cda45b38.tar.xz
nixpkgs-ecee8c3af416051cdde0d2dcdcaec644cda45b38.tar.zst
nixpkgs-ecee8c3af416051cdde0d2dcdcaec644cda45b38.zip
CONTRIBUTING.md: Add overview
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 17f63d1868d..69b47595aba 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -7,6 +7,15 @@ As such, a GitHub account is required, which you can sign up for [here](https://
 Additionally this document assumes that you already know how to use GitHub and Git.
 If that's not the case, we recommend learning about it first [here](https://docs.github.com/en/get-started/quickstart/hello-world).
 
+## Overview
+
+This file contains general contributing information, but individual parts also have more specific information to them in their respective `README.md` files, linked here:
+- [`lib`](./lib): Sources and documentation of the [library functions](https://nixos.org/manual/nixpkgs/stable/#chap-functions)
+- [`maintainers`](./maintainers): Nixpkgs maintainer and team listings, maintainer scripts
+- [`pkgs`](./pkgs): Package and [builder](https://nixos.org/manual/nixpkgs/stable/#part-builders) definitions
+- [`doc`](./doc): Sources and infrastructure for the [Nixpkgs manual](https://nixos.org/manual/nixpkgs/stable/)
+- [`nixos`](./nixos): Implementation of [NixOS](https://nixos.org/manual/nixos/stable/)
+
 ## (Proposing a change) | Submitting changes
 
 Note: contributing implies licensing those contributions