Document release process

NixOS · Sep 23, 2023 · 19651fa · 19651fa
1 parent b3ac0a8
commit 19651fa
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 5 deletions.
diff --git a/MAINTENANCE.md b/MAINTENANCE.md
@@ -0,0 +1,12 @@
+<!-- SPDX-License-Identifier: MPL-2.0
+   -->
+
+# 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
@@ -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