From 299c0dad477f0102bcbe20448618a3a65b9b08d1 Mon Sep 17 00:00:00 2001 From: Fritz Otlinghaus Date: Sat, 20 Apr 2024 15:29:22 +0200 Subject: [PATCH] CONTRIBUTING.md: Add nixpkgs-merge-bot usage paragraph --- CONTRIBUTING.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3623246f6871..23a826d9a7b7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -330,7 +330,14 @@ Container system, boot system and library changes are some examples of the pull ## How to merge pull requests [pr-merge]: #how-to-merge-pull-requests -The *Nixpkgs committers* are people who have been given +To streamline automated updates, leverage the nixpkgs-merge-bot by simply commenting `@NixOS/nixpkgs-merge-bot merge`. The bot will verify if the following conditions are met, refusing to merge otherwise: + +- the commenter that issued the command should be among the package maintainers; +- the package should reside in `pkgs/by-name`. + +Further, nixpkgs-merge-bot will ensure all ofBorg checks (except the Darwin-related ones) are successfully completed before merging the pull request. Should the checks still be underway, the bot patiently waits for ofBorg to finish before attempting the merge again. + +For other pull requests, the *Nixpkgs committers* are people who have been given permission to merge. It is possible for community members that have enough knowledge and experience on a special topic to contribute by merging pull requests.