From b98abe51adcbde4a643a10845a2ace3cc57da4aa Mon Sep 17 00:00:00 2001 From: Silvan Mosberger Date: Tue, 25 Jul 2023 17:20:41 +0200 Subject: [PATCH] README.md: Rough move to new contribution doc files No content was changed, new titles are wrapped with () to signal that they will need to be decided on in a future commit. --- CONTRIBUTING-new.md | 23 +++++++++++++++++++++++ README.md | 21 +-------------------- maintainers/README.md | 6 ++++++ 3 files changed, 30 insertions(+), 20 deletions(-) diff --git a/CONTRIBUTING-new.md b/CONTRIBUTING-new.md index cbcab9ee1db7..41b3e73cb1fb 100644 --- a/CONTRIBUTING-new.md +++ b/CONTRIBUTING-new.md @@ -1 +1,24 @@ # Contributing to Nixpkgs + +## (Proposing a change) + +When pull requests are made, our tooling automation bot, +[OfBorg](https://github.com/NixOS/ofborg) will perform various checks +to help ensure expression quality. + +## (Merging a pull request) + +The *Nixpkgs committers* are people who have been given +permission to merge. + +## (Flow of changes) + +Most contributions are based on and merged into these branches: + +* `master` is the main branch where all small contributions go +* `staging` is branched from master, changes that have a big impact on + Hydra builds go to this branch +* `staging-next` is branched from staging and only fixes to stabilize + and security fixes with a big impact on Hydra builds should be + contributed to this branch. This branch is merged into master when + deemed of sufficiently high quality diff --git a/README.md b/README.md index d840e2a8c503..7284d39a4c13 100644 --- a/README.md +++ b/README.md @@ -70,26 +70,7 @@ Linux distribution. The [GitHub Insights](https://github.com/NixOS/nixpkgs/pulse page gives a sense of the project activity. Community contributions are always welcome through GitHub Issues and -Pull Requests. When pull requests are made, our tooling automation bot, -[OfBorg](https://github.com/NixOS/ofborg) will perform various checks -to help ensure expression quality. - -The *Nixpkgs maintainers* are people who have assigned themselves to -maintain specific individual packages. We encourage people who care -about a package to assign themselves as a maintainer. When a pull -request is made against a package, OfBorg will notify the appropriate -maintainer(s). The *Nixpkgs committers* are people who have been given -permission to merge. - -Most contributions are based on and merged into these branches: - -* `master` is the main branch where all small contributions go -* `staging` is branched from master, changes that have a big impact on - Hydra builds go to this branch -* `staging-next` is branched from staging and only fixes to stabilize - and security fixes with a big impact on Hydra builds should be - contributed to this branch. This branch is merged into master when - deemed of sufficiently high quality +Pull Requests. For more information about contributing to the project, please visit the [contributing page](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md). diff --git a/maintainers/README.md b/maintainers/README.md index 8438533da143..3914586e5b61 100644 --- a/maintainers/README.md +++ b/maintainers/README.md @@ -1 +1,7 @@ # Nixpkgs Maintainers + +The *Nixpkgs maintainers* are people who have assigned themselves to +maintain specific individual packages. We encourage people who care +about a package to assign themselves as a maintainer. When a pull +request is made against a package, OfBorg will notify the appropriate +maintainer(s).