22STARTER_CHARACTER = 🔒
33
44ALWAYS add the 2 character prefix to commit messages.
5+ This is the process to commit changes to git.
56
67## Overview
78
@@ -85,41 +86,40 @@ The general format for commit messages is:
8586
8687## Co-authorship
8788
88- * ALWAYS run tests before commiting
89- * NEVER commit code if tests are failing
90- * ALWAYS suggest a commit message and confirm with the user before commiting.
91-
92-
93- ### Message
94- Choose the most important piece and use it as the title.
95- If extra details are need add them after a line break.
96- Add the Co-authors.
97- Ask if you haven't confirmed for this session, save the confirmation in ` .windsurf/coauthors.txt ` .
98-
99- Sample:
100-
101- > ** Commit Message:** . e added rules
102-
103-
104- ### Co-Authors
105-
106- | name | github_id |
107- | ---- | ---- |
108- | Llewellyn | isidore |
109- | Lars | LarsEckart |
110- | Jay | JayBazuzi |
111- | Scott | ScottBob |
112- | Lada | lexler |
113-
114- Co-authors go 1 per line at the bottom of the message,
115- Credit co-authors.
116-
117- ** Format** :
89+ * ALWAYS run tests before committing.
90+ * NEVER commit code if tests are failing.
91+ * ALWAYS suggest a commit message and confirm with the user before committing.
92+
93+ ### Commit Confirmation Checklist
94+ 1 . Suggest a commit message (with risk, intention, and title).
95+ 2 . Read @coauthors .txt and add them to the commit message.
96+ 3 . Ask the user to confirm or edit the message.
97+ 4 . Only proceed to commit after explicit user confirmation.
98+
99+ ### Co-Author Handling
100+ - The ` .windsurf/coauthors.txt ` file should list only co-authors other than yourself (the committer).
101+ - ** Do not add yourself as a co-author** ; only list collaborators who are not the committer.
102+ - Co-authors are credited at the bottom of the commit message, one per line.
103+
104+ #### Example Workflow
105+ 1 . Suggest a commit message and list the current co-authors from ` .windsurf/coauthors.txt ` .
106+ 2 . Format the co-authors section as shown below.
107+
108+ ### Co-Authors Table
109+ | name | github_id |
110+ | ------------| -----------|
111+ | Llewellyn | isidore |
112+ | Lars | LarsEckart|
113+ | Jay | JayBazuzi |
114+ | Scott | ScottBob |
115+ | Lada | lexler |
116+
117+ ** Format:**
118118```
119119Co-authored-by: <name> <<github_id>@users.noreply.github.com>
120120```
121121
122- ** Example** :
122+ ** Single Co-Author Example: **
123123```
124124- B Fix null pointer exception in payment module
125125
@@ -128,3 +128,23 @@ before accessing payment details. Added null checks.
128128
129129Co-authored-by: Lars <LarsEckart@users.noreply.github.com>
130130```
131+
132+ ** Multiple Co-Authors Example:**
133+ ```
134+ . e Update script: `commit.sh`
135+
136+ Improved commit scripts to check status.
137+
138+ Co-authored-by: Llewellyn <isidore@users.noreply.github.com>
139+ Co-authored-by: Jay <JayBazuzi@users.noreply.github.com>
140+ ```
141+
142+ ---
143+
144+ ## Troubleshooting & FAQ
145+
146+ ** Q: How should ` .windsurf/coauthors.txt ` be managed?**
147+ A: Only list co-authors who are not yourself.
148+
149+ ** Q: What if a co-author is not in the table?**
150+ A: Ask the user for their GitHub username/email and add them using the standard format.
0 commit comments