This commit is contained in:
Tim Van Baak 2024-07-28 20:51:48 -07:00
parent 9c0f4a922a
commit f9374247b1

13
README.md Normal file
View File

@ -0,0 +1,13 @@
# maintainers
This flake provides two bundlers that compile information about the maintainership of packages.
## #unmaintained (#default)
This bundler accepts a derivation or a NixOS configuration and returns a report containing a list of derivations in the closure of the input that have no maintainer in nixpkgs. Each package is accompanied by a link to the package source in nixpkgs. If you see a package in your report that you care about, sign up as a maintainer!
Note that many derivations have no `.meta.maintainers`, e.g. `fetchTarball`. This list specificaly includes packages that _have_ a `.meta.maintainers` that is empty.
## #all
This bundler accepts a derivation or a NixOS configuration and returns a report containing a list of every derivation in the closure of the input and the GitHub usernames of the maintainers. You can use this to see if there are packages you depend on that could use some additional maintainership, e.g. yours!