docs: improve README and add usage notes

This commit is contained in:
2026-03-07 20:15:06 +10:00
parent b87f864908
commit 970d5f6520
2 changed files with 98 additions and 24 deletions
+30
View File
@@ -0,0 +1,30 @@
# Usage notes
This repo is meant to stay lightweight.
## Basic usage idea
When working in a GitHub repo:
1. inspect branch / status / tags / releases if needed
2. assume PR-first if repo rules are unclear
3. avoid release work until the relevant changes are merged
## Mental checklist
Before pushing:
- Am I on `main`?
- Does this repo allow direct push to `main`?
- If I do not know, why am I not using a branch + PR?
Before changing a release:
- Are the intended changes already merged?
- Does `package.json` version match the intended release?
- Are git tags and GitHub releases in sync?
## Core rule
If uncertain, do the safer thing:
- branch
- PR
- merge
- release