Skip to content

Commit faf8e88

Browse files
isidoreLarsEckart
andcommitted
. e Update Arlo Commit Notation documentation
Clarified commit message structure (title, body, co-authors) and added a dedicated section for co-authorship based on recent pair programming session. Also fixed minor typos and clarified risk/intention notes. Co-authored-by: Lars <LarsEckart@users.noreply.github.com>
1 parent ee8873e commit faf8e88

1 file changed

Lines changed: 42 additions & 9 deletions

File tree

.windsurf/ArloCommitNotation.process.md

Lines changed: 42 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
### Arlo Commit Notation
2-
ALWAYS add the 2 charactor prefix to commit messages.
2+
ALWAYS add the 2 character prefix to commit messages.
33

44
## Overview
55

@@ -23,8 +23,7 @@ Each commit message starts with a symbol indicating its risk level:
2323
| `!` | Single Action | Not fully tested, but only 1 thing has changed |
2424
| `@` | Risky | Catch all for everything above single action |
2525

26-
27-
**Note:* if the changes only involve e,d, or t. The risk is always a `.` as those are not shipped to the end user.
26+
**Note:** If the changes only involve intentions `e` (Environment), `d` (Documentation), or `r` (Refactoring), the risk is typically `.` as these are often not shipped directly to the end user or change production behavior.
2827

2928
---
3029

@@ -37,7 +36,8 @@ Following the risk symbol, a letter denotes the intention of the commit:
3736
| `F` | Feature | Add or modify a feature. |
3837
| `B` | Bugfix | Fix a bug or error. |
3938
| `r` | Refactoring | Improve code structure without changing behavior. |
40-
| `d` | Documentation | Update or add documentation. | `e` | Enviroment | changes for the dev to produce code. CI, scripts, etc... |
39+
| `d` | Documentation | Update or add documentation. |
40+
| `e` | Environment | Changes for the dev environment (e.g., CI, scripts, setup). |
4141

4242
**Note on Casing**:
4343

@@ -51,13 +51,46 @@ Following the risk symbol, a letter denotes the intention of the commit:
5151
The general format for commit messages is:
5252

5353
```
54-
<Risk Symbol> <Intention Letter> <Commit Description>
54+
<Risk Symbol> <Intention Letter> <Title>
55+
56+
[Optional Body: Explain the 'why' and 'what' in more detail.]
57+
58+
[Optional Co-authors section, see below]
5559
```
5660

61+
* **Title**: A concise summary of the change, starting with the ACN prefix.
62+
* **Body**: Optional. Provides more context, reasoning, or details about the change. Separate from the title with a blank line.
63+
* **Co-authors**: Optional. List contributors as described in the Co-authorship section. Separate from the body (or title, if no body) with a blank line.
64+
5765
**Examples**:
5866

59-
* `. F Add user login feature`
60-
* `- B Fix null pointer exception in payment module`
61-
* `! r Refactor authentication logic`
62-
* `. d Update README with setup instructions`
67+
* `. F Add user login feature`
68+
* `- B Fix null pointer exception in payment module`
69+
* `! r Refactor authentication logic`
70+
* `. d Update README with setup instructions`
71+
* `. e Add commit script
72+
73+
Added a script to streamline the commit process.`
74+
75+
---
76+
77+
## Co-authorship
78+
6379

80+
If you are not sure who to credit, ask for a list of the co-authors.
81+
Credit co-authors.
82+
83+
**Format**:
84+
```
85+
Co-authored-by: Name <github_id@users.noreply.github.com>
86+
```
87+
88+
**Example**:
89+
```
90+
- B Fix null pointer exception in payment module
91+
92+
The fix addresses the case where the user profile is not fully loaded
93+
before accessing payment details. Added null checks.
94+
95+
Co-authored-by: Lars <LarsEckart@users.noreply.github.com>
96+
```

0 commit comments

Comments
 (0)