Update 'CONTRIBUTING.md'.

mawkler · Jan 16, 2023 · 305debd · 305debd
1 parent cc7dd9d
commit 305debd
Showing 1 changed file with 10 additions and 4 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -68,23 +68,29 @@ This project uses [StyLua](https://github.com/JohnnyMorganz/StyLua) version 0.14
     - Update 'lua/init.lua' to mention new module: both in initial table of contents and list of modules.
     - Update 'scripts/minidoc.lua' to generate separate help file.
     - Generate help files.
-    - Add README to 'readmes' directory.
+    - Add README to 'readmes' directory. NOTE: comment out mentions of `stable` branch, as it won't work during beta-testing.
     - Update main README to mention new module: both in table of contents and subsection.
     - Update 'scripts/dual_sync.sh' to include new module.
     - Update 'CHANGELOG.md' to mention introduction of new module.
     - Make standalone plugin:
-        - Create new empty GitHub repository.
+        - Create new empty GitHub repository. Disable Issues and limit PRs.
         - Create initial structure. For list of tracked files see 'scripts/dual_sync.sh'. Initially they are 'doc/mini-xxx.txt', 'lua/mini/xxx.lua', 'LICENSE', and 'readmes/mini-xxx.md' (copied to be 'README.md' in standalone repository). NOTE: Modify 'README.md' to have appropriate relative links (see patch script).
         - Make initial commit and push.
 
 - Checklist for making release:
+    - Check for `TODO`s about actions to be done *before* release.
+    - Update READMEs of new modules to mention `stable` branch.
     - Bump version in 'CHANGELOG.md'. Commit.
-    - Checkout to `new_release` branch and push to check in CI. Proceed only if it is successful.
+    - Checkout to `new_release` branch and push to check in CI. **Proceed only if it is successful**.
     - Make annotated tag: `git tag -a v0.xx.0 -m 'Version 0.xx.0'`. Push it.
-    - Move `stable` branch to point at new tag.
     - Check that all CI has passed.
     - Make GitHub release. Get description from copying entries of version's 'CHANGELOG.md' section.
+    - Move `stable` branch to point at new tag.
+    - Manage standalone repositories. In each one:
+        - Make annotated tag.
+        - Move existing `stable` branch or create one if it doesn't exist.
     - Use development version in 'CHANGELOG.md' ('0.(xx + 1).0.9000'). Commit.
+    - Check for `TODO`s about actions to be done *after* release.
 
 ## List of highlight groups