From 4685c36e2f3b64f1fca7cb24ea207d928e6bf396 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Aleix=20Bon=C3=A9?= Date: Fri, 10 Oct 2025 15:06:04 +0200 Subject: [PATCH] Add brief documentation on maintainer roles Reviewed-by: Rodrigo Arias Mallo Tested-by: Rodrigo Arias Mallo --- doc/maintainers.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 doc/maintainers.md diff --git a/doc/maintainers.md b/doc/maintainers.md new file mode 100644 index 00000000..4aac6e21 --- /dev/null +++ b/doc/maintainers.md @@ -0,0 +1,30 @@ +# Maintainers + +## Role of a maintainer +The responsibilities of maintainers are quite lax, and similar in spirit to +[nixpkgs' maintainers][1]: + + The main responsibility of a maintainer is to keep the packages they + maintain in a functioning state, and keep up with updates. In order to do + that, they are empowered to make decisions over the packages they maintain. + + That being said, the maintainer is not alone in proposing changes to the + packages. Anybody (both bots and humans) can send PRs to bump or tweak the + package. + +In practice, this means that when updating or proposing changes to a package, +we will notify maintainers by mentioning them in Gitea so they can test changes +and give feedback. + +Since we do bi-yearly release cycles, there is no expectation from maintainers +to update packages at each upstream release. Nevertheless, on each release cycle +we may request help from maintainers when updating or testing their packages. + +## Becoming a maintainer + + +You'll have to add yourself in the `maintainers.nix` list; your username should +match your `bsc.es` email. Then you can add yourself to the `meta.maintainers` +of any package you are interested in maintaining. + +[1]: [https://github.com/NixOS/nixpkgs/tree/nixos-25.05/maintainers]