You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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>
Copy file name to clipboardExpand all lines: .windsurf/ArloCommitNotation.process.md
+42-9Lines changed: 42 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
### Arlo Commit Notation
2
-
ALWAYS add the 2 charactor prefix to commit messages.
2
+
ALWAYS add the 2 character prefix to commit messages.
3
3
4
4
## Overview
5
5
@@ -23,8 +23,7 @@ Each commit message starts with a symbol indicating its risk level:
23
23
|`!`| Single Action | Not fully tested, but only 1 thing has changed |
24
24
|`@`| Risky | Catch all for everything above single action |
25
25
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.
28
27
29
28
---
30
29
@@ -37,7 +36,8 @@ Following the risk symbol, a letter denotes the intention of the commit:
37
36
|`F`| Feature | Add or modify a feature. |
38
37
|`B`| Bugfix | Fix a bug or error. |
39
38
|`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). |
41
41
42
42
**Note on Casing**:
43
43
@@ -51,13 +51,46 @@ Following the risk symbol, a letter denotes the intention of the commit:
[Optional Body: Explain the 'why' and 'what' in more detail.]
57
+
58
+
[Optional Co-authors section, see below]
55
59
```
56
60
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
+
57
65
**Examples**:
58
66
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
+
63
79
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>
0 commit comments