Add a file for maintenance instructions

lornajane · Mar 30, 2024 · 3caec2a · 3caec2a
1 parent 4cb7d6a
commit 3caec2a
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/MAINTAINING.md b/MAINTAINING.md
@@ -0,0 +1,12 @@
+The maintainers file is instructions for maintainers on operating the project.
+Especially useful for things that don't need to be done often!
+
+## Releasing a package version
+
+1. Update `package.json` with the new version number, and merge this change to the main branch.
+
+2. Tag the main branch with the new version `git tag -a v0.1.0 -m "Release version 0.1.0"`.
+
+3. Push the tag to the repo: `git push origin v0.1.0`.
+
+4. Publish to npm: `npm publish`.