Skip to content

Commit

Permalink
maintainers-list: create a field inactivityReason
Browse files Browse the repository at this point in the history
Default null; should be a free-form string explaining why the maintainer
became inactive.

The most immediate use of this attribute is to mark maintainers that are
not contributing to Nixpkgs from a long amount of time. Nonetheless it can
be used to mark any *long term inactivity*, including but not limited to:

- Sabbatical leave
- Retirement
- Intimate issues
- Force majeure

In principle, a third person can set this attribute. For the sake of a good
etiquette, in such case at least one contact attempt should be issued and
carried out before effectively committing it to the codebase.

This attribute can be employed to many useful activities, including but not
limited to:

- Treewide automation
  - Removal of inactive maintainers from packages
  - Orphaning alerts
- Filter automatic notifications
  • Loading branch information
AndersonTorres committed Jul 3, 2024
1 parent 46d2f0f commit c2f4dac
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 0 deletions.
4 changes: 4 additions & 0 deletions lib/tests/maintainer-module.nix
Original file line number Diff line number Diff line change
Expand Up @@ -28,5 +28,9 @@ in {
});
default = [];
};
inactivityReason = lib.mkOption {
type = types.nullOr types.str;
default = null;
};
};
}
32 changes: 32 additions & 0 deletions maintainers/maintainer-list.nix
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,37 @@
keys = [{
fingerprint = "AAAA BBBB CCCC DDDD EEEE FFFF 0000 1111 2222 3333";
}];

# Default null; should be a free-form string explaining why the maintainer
# became inactive.
#
# The most immediate use of this attribute is to mark maintainers that are
# not contributing to Nixpkgs from a long amount of time.
# Nonetheless it can be used to mark any *long term inactivity*, including
# but not limited to:
#
# - Sabbatical leave
# - Retirement
# - Intimate issues
# - Force majeure
#
# In principle, a third person can set this attribute. For the sake of a
# good etiquette, in such case at least one contact attempt should be
# issued and carried out before effectively committing it to the codebase.
#
# This attribute can be employed to many useful activities, including but
# not limited to:
#
# - Treewide automation
# - Removal of inactive maintainers from packages
# - Orphaning alerts
# - Filter automatic notifications
#
inactivityReason = ''
Real life issues: I want to take the Hunter Exam this year.

Registered at 2024-06-19 by Theresia.
'';
};
```

Expand All @@ -26,6 +57,7 @@
- `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.
- `inactivityReason` is an optional string attribute, explained above.

Specifying a GitHub account ensures that you automatically:
- get invited to the @NixOS/nixpkgs-maintainers team ;
Expand Down

0 comments on commit c2f4dac

Please sign in to comment.