summaryrefslogtreecommitdiff
path: root/procedures/GROWL.md
diff options
context:
space:
mode:
authordoc <doc@filenotfound.org>2025-06-30 20:06:28 +0000
committerdoc <doc@filenotfound.org>2025-06-30 20:06:28 +0000
commit717fcb9c81d2bc3cc7a84a3ebea6572d7ff0f5cf (patch)
tree7cbd6a8d5046409a82b22d34b01aac93b3e24818 /procedures/GROWL.md
parent8368ff389ec596dee6212ebeb85e01c638364fb3 (diff)
uploading documentationHEADmaster
Diffstat (limited to 'procedures/GROWL.md')
-rw-r--r--procedures/GROWL.md111
1 files changed, 111 insertions, 0 deletions
diff --git a/procedures/GROWL.md b/procedures/GROWL.md
new file mode 100644
index 0000000..119682d
--- /dev/null
+++ b/procedures/GROWL.md
@@ -0,0 +1,111 @@
+# GROWL — Genesis Radio Commit Style Guide
+
+---
+
+## 🛡️ Purpose
+
+To keep our Git commit history **clean, calm, and clear** —
+even during chaos, downtime, or tired late-night edits.
+
+Every commit should **GROWL**:
+
+| Letter | Meaning |
+|:---|:---|
+| **G** | Good |
+| **R** | Readable |
+| **O** | Obvious |
+| **W** | Well-Scoped |
+| **L** | Logical |
+
+---
+
+## 🧠 GROWL Principles
+
+### **G — Good**
+
+Write clear, helpful commit messages.
+Imagine your future self — tired, panicked — trying to understand what you did.
+
+**Bad:**
+`update`
+
+**Good:**
+`Fix retry logic for mount guardian script`
+
+---
+
+### **R — Readable**
+
+Use short, plain English sentences.
+No cryptic shorthand. No weird abbreviations.
+
+**Bad:**
+`fx psh scrpt`
+
+**Good:**
+`Fix powershell script argument passing error`
+
+---
+
+### **O — Obvious**
+
+The commit message should explain what changed without needing a diff.
+
+**Bad:**
+`misc`
+
+**Good:**
+`Add dark mode CSS to healthcheck dashboard`
+
+---
+
+### **W — Well-Scoped**
+
+One logical change per commit.
+Don't fix five things at once unless they're tightly related.
+
+**Bad:**
+`fix mount issues, added healthcheck, tweaked retry`
+
+**Good:**
+`Fix asset mount detection timing issue`
+
+(And then a separate commit for healthcheck tweaks.)
+
+---
+
+### **L — Logical**
+
+Commits should build logically.
+Each one should bring the repo to a **better, deployable state** — not leave it broken.
+
+**Bad:**
+Commit partial broken code just because "I need to leave soon."
+
+**Good:**
+Finish a working block, then commit.
+
+---
+
+## 📋 Quick GROWL Checklist Before You Push:
+
+- [ ] Is my message clear to a stranger?
+- [ ] Did I only change one logical thing?
+- [ ] Can I tell from the commit what changed, without a diff?
+- [ ] Would sleepy me at 3AM thank me for writing this?
+
+---
+
+## 🎙️ Why We GROWL
+
+Because panic, fatigue, or adrenaline can't be avoided —
+but **good habits under pressure can save a system** (and a future you) every time.
+
+Stay calm.
+Make it obvious.
+Let it GROWL.
+
+---
+
+# 🐺 Genesis Radio Operations
+*Built with pride. Built to last.*