auxolotl/core
26
2
Fork 1
Code Issues 1 Pull requests 5 Actions Packages Projects Releases Wiki Activity

docs: Add maintainer list

Browse source 
We should reflect that we are now on Forgejo and have a different
process to the Nixos organization for adding maintainers.

Reviewed-on: #17
Reviewed-by: Coded <me@thecoded.prof>
Co-authored-by: isabel <isabel@isabelroses.com>
Co-committed-by: isabel <isabel@isabelroses.com>
This commit is contained in:
isabel roses 2024-07-01 16:09:04 +00:00 committed by coded
parent 9ed579059e
commit c13b60bc67
1 changed files with 40 additions and 56 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

40
maintainers/maintainer-list.nix
View file

@ -1,14 +1,15 @@
/* List of NixOS maintainers.
/*
List of Aux maintainers.
```nix
handle = {
# Required
name = "Your name";
forgejo = "forgejoUsername";
forgejoId = your-forgejo-id;
# Optional, but at least one of email, matrix or githubId must be given
# Optional, but at least one of email or matrix must be given
email = "address@example.org";
matrix = "@user:example.org";
github = "GithubUsername";
githubId = your-github-id;
keys = [{
fingerprint = "AAAA BBBB CCCC DDDD EEEE FFFF 0000 1111 2222 3333";
@ -22,21 +23,16 @@
- `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>`,
- `forgejo` is your forgejo handle (as it appears in the URL of your profile page, `https://git.auxolotl.org/<userhandle>`),
- `forgejoId` is your forgejo user ID, which can be found at `https://git.auxolotl.org/api/v1/users/<username>`,
- `keys` is a list of your PGP/GPG key fingerprints.
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.
`handle == forgejo` is strongly preferred whenever `forgejo` is an acceptable attribute name and is short and convenient.
`handle == github` is strongly preferred whenever `github` is an acceptable attribute name and is short and convenient.
If `github` begins with a numeral, `handle` should be prefixed with an underscore.
If `forgejo` begins with a numeral, `handle` should be prefixed with an underscore.
```nix
_1example = {
github = "1example";
forgejo = "1example";
};
```
@ -51,18 +47,6 @@
More fields may be added in the future, however, in order to comply with GDPR this file should stay as minimal as possible.
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
See `./scripts/check-maintainer-github-handles.sh` for an example on how to work with this data.
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.
When editing this file, please ensure that you have added yourself in alphabetical order of your handle.
*/
{
}
{ }