Skip to content

Commit 8abc9c4

Browse files
committed
. e Manual edits
1 parent 814035a commit 8abc9c4

File tree

1 file changed

+16
-17
lines changed

1 file changed

+16
-17
lines changed

.windsurf/ArloCommitNotation.process.md

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,9 @@ Arlo Commit Notation is a system for prefixing commit messages with a short code
55
## Commit Message Structure
66

77
```
8-
[hash] [prefix] [commit message]
8+
[prefix] [commit message]
99
```
1010

11-
- **hash**: The git commit hash.
1211
- **prefix**: A short code, typically two characters (sometimes more), that encodes information about the commit.
1312
- **commit message**: Description of the change.
1413

@@ -20,39 +19,39 @@ The prefix generally follows this pattern:
2019
[symbol][space][letter(s)]
2120
```
2221

23-
- **symbol**: One of `.`, `-`, `!`, `@`, `***`, `v`, or none.
22+
- **symbol**: One of `.`, `-`, `!`, `@`, `***`.
2423
- **letter(s)**: One or more letters, usually a single uppercase or lowercase letter, sometimes two (`dt`).
2524

2625
### Observed Prefixes and Likely Meanings
2726

2827
| Prefix | Meaning (Inferred) |
2928
|-----------|---------------------------------------|
30-
| `. e` | Enhancement, engineering, or edit (not shipped to user, e.g., scripts, infra) |
29+
| `. e` | Environment / Changes that are only used by the developer to use the system (not shipped to user, e.g., scripts, infra) |
3130
| `. d` | Documentation (not shipped to user) |
3231
| `. t` | Test (not shipped to user) |
33-
| `. r` | Refactor (not shipped to user, or tooling-safe refactor) |
32+
| `. r` | Refactor (tooling-safe refactor) |
3433
| `. C` | Release/Changelog |
35-
| `- r` | Refactor (possibly higher risk) |
36-
| `- F` | Feature (possibly higher risk) |
37-
| `! r` | Risky refactor |
38-
| `! F` | Risky feature |
39-
| `@ r` | Refactor (special context) |
40-
| `@ F` | Feature (special context) |
41-
| `***` | Major/experimental/unknown |
42-
| `v` | Version bump/release |
43-
| `a` | Automated/formatting |
44-
| `. dt` | Documentation for DynamicTest |
34+
| `- r` | Refactor (unit tested) |
35+
| `- F` | Feature (unit tested) |
36+
| `! r` | Risky refactor (but single change) |
37+
| `! F` | Risky feature (but single change) |
38+
| `@ r` | Refactor (really risky) |
39+
| `@ F` | Feature (really risky) |
40+
| `***` | Work in progress (these are intermediate commits in a chain of the thought. The project is usually in a broken state at this point) |
41+
42+
| `. a` | Automated/formatting |
43+
| `. dt` | Documentation with Sample Code in a Unit Test |
4544
| (none) | Merge, bump, or update (auto/merge) |
4645

47-
> **Note:** The exact meaning of each prefix may depend on team conventions. The above are inferred from commit messages and may need confirmation.
46+
## Inconsistencies
47+
Some of the commits in this repository are not going to adhere to our format. Those are mistakes. Don't base your rules on them.
4848

4949
## Guidelines for Use
5050

5151
- Always use a prefix unless the commit is a merge, bump, or automated update.
5252
- Choose the symbol and letter(s) that best match the intent and risk of the commit.
5353
- Use uppercase letters for features, releases, or high-impact changes.
5454
- Use special symbols (`-`, `!`, `@`, `***`) to indicate increased risk, automation, or special cases.
55-
- For version bumps, use `v` followed by the version number.
5655

5756
## Next Steps
5857

0 commit comments

Comments
 (0)