Add HACKING.md

polytypic · polytypic · commit 0077037ebb2b · 2024-03-24T21:51:40.000+02:00
diff --git a/HACKING.md b/HACKING.md
@@ -0,0 +1,11 @@
+### Formatting
+
+This project uses [ocamlformat](https://github.com/ocaml-ppx/ocamlformat) (for
+OCaml) and [prettier](https://prettier.io/) (for Markdown).
+
+### To make a new release
+
+1. Update [CHANGES.md](CHANGES.md).
+2. Run `dune-release tag VERSION` to create a tag for the new `VERSION`.
+3. Run `dune-release` to publish the new `VERSION`.
+4. Run `./update-gh-pages-for-tag VERSION` to update the online documentation.
