maintainers/maintainer-list.nix: make the top comment a bit more readable
This commit is contained in:
parent
5f5905e30e
commit
45df055094
|
@ -1,21 +1,27 @@
|
||||||
/* List of NixOS maintainers.
|
/* List of NixOS maintainers.
|
||||||
|
|
||||||
handle = {
|
handle = {
|
||||||
|
# Required
|
||||||
name = "Real name";
|
name = "Real name";
|
||||||
email = "address@example.org";
|
email = "address@example.org";
|
||||||
|
|
||||||
|
# Optional
|
||||||
github = "GithubUsername";
|
github = "GithubUsername";
|
||||||
};
|
};
|
||||||
|
|
||||||
where `name` is your real name, `email` is your maintainer email
|
where
|
||||||
address and `github` is your GitHub handle (as it appears in the
|
|
||||||
URL of your profile page, `https://github.com/<userhandle>`).
|
- `handle` is the handle you are going to use in nixpkgs expressions,
|
||||||
address
|
- `name` is your real name,
|
||||||
The only required fields are `name` and `email`.
|
- `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.
|
More fields may be added in the future.
|
||||||
|
|
||||||
Please keep the list alphabetically sorted.
|
Please keep the list alphabetically sorted.
|
||||||
See `../maintainers/scripts/check-maintainer-github-handles.sh`
|
See `./scripts/check-maintainer-github-handles.sh` for an example on how to work with this data.
|
||||||
for an example on how to work with this data.
|
|
||||||
*/
|
*/
|
||||||
{
|
{
|
||||||
"1000101" = {
|
"1000101" = {
|
||||||
|
|
Loading…
Reference in a new issue