diff options
author | Jan Malakhovski <oxij@oxij.org> | 2018-10-02 15:17:36 +0000 |
---|---|---|
committer | Jan Malakhovski <oxij@oxij.org> | 2018-10-02 15:17:36 +0000 |
commit | 45df0550943e14f32cda8898834e90440f5c08c9 (patch) | |
tree | b25ec7b83a3e84ba068abb5c1208452483407e42 /maintainers/maintainer-list.nix | |
parent | 5f5905e30e86db1ac72b98f41873f63606418cfa (diff) | |
download | nixlib-45df0550943e14f32cda8898834e90440f5c08c9.tar nixlib-45df0550943e14f32cda8898834e90440f5c08c9.tar.gz nixlib-45df0550943e14f32cda8898834e90440f5c08c9.tar.bz2 nixlib-45df0550943e14f32cda8898834e90440f5c08c9.tar.lz nixlib-45df0550943e14f32cda8898834e90440f5c08c9.tar.xz nixlib-45df0550943e14f32cda8898834e90440f5c08c9.tar.zst nixlib-45df0550943e14f32cda8898834e90440f5c08c9.zip |
maintainers/maintainer-list.nix: make the top comment a bit more readable
Diffstat (limited to 'maintainers/maintainer-list.nix')
-rw-r--r-- | maintainers/maintainer-list.nix | 20 |
1 files changed, 13 insertions, 7 deletions
diff --git a/maintainers/maintainer-list.nix b/maintainers/maintainer-list.nix index 3b7329a8d790..11ccbfc9b47f 100644 --- a/maintainers/maintainer-list.nix +++ b/maintainers/maintainer-list.nix @@ -1,21 +1,27 @@ /* List of NixOS maintainers. handle = { + # Required name = "Real name"; email = "address@example.org"; + + # Optional github = "GithubUsername"; }; - where `name` is your real name, `email` is your maintainer email - address and `github` is your GitHub handle (as it appears in the - URL of your profile page, `https://github.com/<userhandle>`). - address - The only required fields are `name` and `email`. + where + + - `handle` is the handle you are going to use in nixpkgs expressions, + - `name` is your real name, + - `email` is your maintainer email address, and + - `github` is your GitHub handle (as it appears in the URL of your profile page, `https://github.com/<userhandle>`). + + `handle == github` is strongly preffered whenever `github` is an acceptable attribute name and is short and convenient. + More fields may be added in the future. Please keep the list alphabetically sorted. - See `../maintainers/scripts/check-maintainer-github-handles.sh` - for an example on how to work with this data. + See `./scripts/check-maintainer-github-handles.sh` for an example on how to work with this data. */ { "1000101" = { |