summaryrefslogtreecommitdiff
path: root/procedures/GROWL.md
blob: 119682dd79f0892024d86382ea4bb8fc4a9370a0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
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.*