From bd6a1e163cac33e6b583000fd22de0c69f2bd09d Mon Sep 17 00:00:00 2001 From: "(cdep)illabout" Date: Sun, 30 May 2021 11:51:42 +0900 Subject: [PATCH] haskell-updates: update workflow documentation to put goal first --- pkgs/development/haskell-modules/HACKING.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/pkgs/development/haskell-modules/HACKING.md b/pkgs/development/haskell-modules/HACKING.md index c8a74e2f5a0247..96b9e3393528c1 100644 --- a/pkgs/development/haskell-modules/HACKING.md +++ b/pkgs/development/haskell-modules/HACKING.md @@ -1,15 +1,16 @@ ## Maintainer Workflow -This is the documentation for periodically merging the `haskell-updates` branch -into the `master` branch. This workflow is performed by members in the -[@NixOS/haskell](https://github.com/orgs/NixOS/teams/haskell) team. -Each member of the team takes a two week period where they are in charge of -merging the `haskell-updates` branch into `master`. +The goal of the [@NixOS/haskell](https://github.com/orgs/NixOS/teams/haskell) +team is to keep the Haskell packages in Nixpkgs up-to-date, while making sure +there are no Haskell-related evaluation errors or build errors that get into +the Nixpkgs `master` branch. -The goal of this workflow is to regularly merge the `haskell-updates` branch -into the `master` branch, while making sure there are no evaluation errors or -build errors that get into `master`. +We do this by periodically merging an updated set of Haskell packages on the +`haskell-updates` branch into the `master` branch. Each member of the team +takes a two week period where they are in charge of merging the +`haskell-updates` branch into `master`. This is the documentation for this +workflow. The workflow generally proceeds in three main steps: @@ -17,7 +18,7 @@ The workflow generally proceeds in three main steps: 1. wait for contributors to fix newly broken Haskell packages 1. merge `haskell-updates` into `master` -We describe each of these steps in a separate section. +Each of these steps is described in a separate section. ### Initial `haskell-updates` PR