core/maintainers/maintainer-list.nix

70 lines
2.5 KiB
Nix
Raw Normal View History

2024-06-30 08:16:52 +00:00
/*
List of NixOS maintainers.
```nix
handle = {
# Required
name = "Your name";
2024-05-02 00:46:19 +00:00
2024-06-30 08:16:52 +00:00
# Optional, but at least one of email, matrix or githubId must be given
email = "address@example.org";
matrix = "@user:example.org";
github = "GithubUsername";
githubId = your-github-id;
2024-05-02 00:46:19 +00:00
2024-06-30 08:16:52 +00:00
keys = [{
fingerprint = "AAAA BBBB CCCC DDDD EEEE FFFF 0000 1111 2222 3333";
}];
};
```
2024-05-02 00:46:19 +00:00
2024-06-30 08:16:52 +00:00
where
2024-05-02 00:46:19 +00:00
2024-06-30 08:16:52 +00:00
- `handle` is the handle you are going to use in nixpkgs expressions,
- `name` is a name that people would know and recognize you by,
- `email` is your maintainer email address,
- `matrix` is your Matrix user ID,
- `github` is your GitHub handle (as it appears in the URL of your profile page, `https://github.com/<userhandle>`),
- `githubId` is your GitHub user ID, which can be found at `https://api.github.com/users/<userhandle>`,
- `keys` is a list of your PGP/GPG key fingerprints.
2024-05-02 00:46:19 +00:00
2024-06-30 08:16:52 +00:00
Specifying a GitHub account ensures that you automatically:
- get invited to the @NixOS/nixpkgs-maintainers team ;
- once you are part of the @NixOS org, OfBorg will request you review
pull requests that modify a package for which you are a maintainer.
2024-05-02 00:46:19 +00:00
2024-06-30 08:16:52 +00:00
`handle == github` is strongly preferred whenever `github` is an acceptable attribute name and is short and convenient.
2024-05-02 00:46:19 +00:00
2024-06-30 08:16:52 +00:00
If `github` begins with a numeral, `handle` should be prefixed with an underscore.
```nix
_1example = {
github = "1example";
};
```
2024-05-02 00:46:19 +00:00
2024-06-30 08:16:52 +00:00
Add PGP/GPG keys only if you actually use them to sign commits and/or mail.
2024-05-02 00:46:19 +00:00
2024-06-30 08:16:52 +00:00
To get the required PGP/GPG values for a key run
```shell
gpg --fingerprint <email> | head -n 2
```
2024-05-02 00:46:19 +00:00
2024-06-30 08:16:52 +00:00
!!! Note that PGP/GPG values stored here are for informational purposes only, don't use this file as a source of truth.
2024-05-02 00:46:19 +00:00
2024-06-30 08:16:52 +00:00
More fields may be added in the future, however, in order to comply with GDPR this file should stay as minimal as possible.
2024-05-02 00:46:19 +00:00
2024-06-30 08:16:52 +00:00
When editing this file:
* keep the list alphabetically sorted, check with:
nix-instantiate --eval maintainers/scripts/check-maintainers-sorted.nix
* test the validity of the format with:
nix-build lib/tests/maintainers.nix
2024-05-02 00:46:19 +00:00
2024-06-30 08:16:52 +00:00
See `./scripts/check-maintainer-github-handles.sh` for an example on how to work with this data.
2024-05-02 00:46:19 +00:00
2024-06-30 08:16:52 +00:00
When adding a new maintainer, be aware of the current commit conventions
documented at [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md#commit-conventions)
file located in the root of the Nixpkgs repo.
2024-05-02 00:46:19 +00:00
*/
{
}