From 19651fa73853970e9caeb0afb21fb35fad76e202 Mon Sep 17 00:00:00 2001 From: piegames Date: Sat, 23 Sep 2023 10:01:18 +0200 Subject: [PATCH] Document release process --- MAINTENANCE.md | 12 ++++++++++++ README.md | 5 ----- 2 files changed, 12 insertions(+), 5 deletions(-) create mode 100644 MAINTENANCE.md diff --git a/MAINTENANCE.md b/MAINTENANCE.md new file mode 100644 index 00000000..cb049458 --- /dev/null +++ b/MAINTENANCE.md @@ -0,0 +1,12 @@ + + +# Maintainer documentation + +## Making a new release + +- Check the commit log if anything is missing from the change log. +- Use `cabal gen-bounds` to see if the bounds can be relaxed (see also [#130](https://github.com/serokell/nixfmt/issues/130)). +- Bump the version. +- Give it a git tag. +- Upload to hackage using `cabal sdist`. See https://hackage.haskell.org/upload for details. diff --git a/README.md b/README.md index 47ea37fd..89b8b239 100644 --- a/README.md +++ b/README.md @@ -51,11 +51,6 @@ Haskell dependencies will be built by Cabal. * `nixfmt file.nix` – format the file in place -## For Contributors - -We welcome issues and pull requests on GitHub. - - ## About Serokell `nixfmt` is maintained and funded with :heart: by