Cline rules

1# Git Commit Guidelines
2 
3This document provides guidelines for creating meaningful git commits in the paper-games repository.
4 
5## Default Commit Behavior
6 
7When asked to create a git commit, unless explicitly instructed otherwise:
8 
9### 1. Include All Changes
10- **Stage all modified files**: Use `git add -A` or `git add .`
11- **Include new files**: Ensure all newly created files are staged
12- **Include deletions**: If files were removed, include those changes
13- **Check status first**: Always run `git status` to verify what will be committed
14 
15### 2. Meaningful Commit Messages
16Commit messages should be:
17- **Descriptive**: Clearly explain what was changed and why
18- **Concise**: Keep it simple and to the point
19- **Action-oriented**: Use imperative mood (Add, Fix, Update, etc.)
20 
21## Commit Message Format
22 
23### Structure
24```
25<Short imperative summary of the change>
26 
27- <Bullet point describing change 1>
28- <Bullet point describing change 2>
29- <Bullet point describing change 3>
30- <Additional details as needed>
31```
32 
33**Key Points:**
34- **No type prefixes** (no "feat:", "fix:", "chore:", etc.)
35- Start with a verb in imperative mood (Add, Fix, Update, Improve)
36- Use simple bullet points with dashes
37- Keep it concise and focused on what changed
38- No formal sections like "Changes:", "Files modified:", "Benefits:"
39 
40## Examples
41 
42### Example 1: Adding a New Game
43```bash
44git add -A
45git commit -m &quot;Add Pic-a-Pix nonogram game with 15x15 and 20x20 grid options
46 
47- Created complete Pic-a-Pix (Nonogram) game with random puzzle generation
48- Added grid size options: 15x15 and 20x20
49- Implemented difficulty levels: Easy, Medium, Hard
50- Features left-click to fill cells, right-click to mark empty cells
51- Added solution checking and reveal functionality
52- Integrated game into landing page alongside existing games
53- Includes comprehensive game instructions and solving tips
54- Responsive design for mobile and desktop
55- References Wikipedia nonogram article for game rules&quot;
56```
57 
58### Example 2: Simple Update
59```bash
60git add -A
61git commit -m &quot;Add Bouncing Balls game to homepage and improve navigation
62 
63- Added Bouncing Balls to the games list on the main landing page
64- Updated navigation button text from 'Explore More Games' to 'Back to Games' in bouncing-balls page for better clarity
65- Included all bouncing-balls game files (HTML, CSS, JavaScript, and assets)&quot;
66```
67 
68### Example 3: Bug Fix
69```bash
70git add -A
71git commit -m &quot;Fix hard AI in Order-Chaos to properly consider both X and O symbols
72 
73- Modified AI logic to evaluate both X and O placement options
74- Improved decision-making for optimal gameplay
75- AI now makes better strategic choices&quot;
76```
77 
78### Example 4: Minor Update
79```bash
80git add -A
81git commit -m &quot;Add last move highlighting to Order &amp; Chaos game
82 
83- Added visual highlight to show the most recent move
84- Helps players track game progression
85- Improves user experience&quot;
86```
87 
88### Example 5: Multiple File Changes
89```bash
90git add -A
91git commit -m &quot;Extract common styles and utilities to shared directory
92 
93- Created common/ directory with shared CSS, JavaScript, and assets
94- Updated all game projects to reference common resources
95- Reduced code duplication across projects
96- Added documentation for common resources in .clinerules/&quot;
97```
98 
99## Git Workflow
100 
101### Before Committing
102 
1031. **Check status**
104```bash
105   git status
106```
107 
1082. **Review changes**
109```bash
110   git diff
111```
112 
1133. **Test the changes**
114   - Verify all games still work
115   - Check for console errors
116   - Test on mobile devices
117   - Validate HTML/CSS
118 
119### Creating the Commit
120 
1211. **Stage all changes** (default behavior)
122```bash
123   git add -A
124```
125 
1262. **Or stage specific files** (when instructed)
127```bash
128   git add path/to/file1.html path/to/file2.css
129```
130 
1313. **Create commit with detailed message**
132```bash
133   git commit -m &quot;type: short summary
134 
135   Detailed description...
136   
137   Changes:
138   - change 1
139   - change 2&quot;
140```
141 
1424. **Verify commit**
143```bash
144   git log -1 --stat
145```
146 
147### After Committing
148 
1491. **Push to remote** (if appropriate)
150```bash
151   git push origin main
152```
153 
1542. **Verify on GitHub** (if pushed)
155   - Check that all files were uploaded
156   - Review commit message display
157   - Ensure no sensitive information was included
158 
159## What NOT to Commit
160 
161❌ **Never commit:**
162- Temporary files (.DS_Store, Thumbs.db, *.swp)
163- IDE/editor config files (unless project-specific)
164- Node modules or dependencies (if applicable)
165- Sensitive information (API keys, passwords)
166- Large binary files (compress images first)
167- Build artifacts (unless intended for GitHub Pages)
168 
169## Special Cases
170 
171### Partial Commits
172If explicitly instructed to commit only specific files:
173```bash
174git add path/to/specific/file.html
175git commit -m &quot;fix: Update specific file only
176 
177Only modifying [file] because [reason].
178 
179Files modified:
180- path/to/specific/file.html&quot;
181```
182 
183### Amending Previous Commit
184If instructed to amend the last commit:
185```bash
186git add -A
187git commit --amend -m &quot;Updated commit message&quot;
188```
189 
190### Breaking Changes
191If changes break existing functionality:
192```bash
193git commit -m &quot;refactor!: Major restructuring of project
194 
195BREAKING CHANGE: Project structure has been reorganized.
196All projects must update their import paths.
197 
198See migration guide in common/README.md&quot;
199```
200 
201## Commit Message Best Practices
202 
203### DO ✅
204- Use present tense ("Add feature" not "Added feature")
205- Be specific about what changed
206- Include context about why changes were made
207- List all significant files affected
208- Group related changes together
209- Keep the summary under 50 characters
210- Wrap detailed description at 72 characters
211- Use bullet points for multiple changes
212 
213### DON'T ❌
214- Write vague messages ("Updated files", "Fixed stuff")
215- Forget to mention important changes
216- Commit without testing first
217- Mix unrelated changes in one commit
218- Use past tense in summary
219- Write overly long summaries
220- Omit the "why" behind changes
221 
222## Quick Reference
223 
224```bash
225# Standard commit workflow (DEFAULT)
226git status                    # Check what changed
227git add -A                    # Stage all changes
228git commit -m &quot;type: summary
229 
230Detailed description
231 
232Changes:
233- item 1
234- item 2&quot;
235git push origin main         # Push to remote
236 
237# Verify commit
238git log -1 --stat            # View last commit with files
239git show                     # View last commit details
240```
241 
242## Automation
243 
244When asked to "create a git commit" or "commit these changes":
2451. Always use `git add -A` unless told otherwise
2462. Generate a meaningful commit message that:
247   - Identifies the type of change
248   - Summarizes all changes clearly
249   - Lists specific modifications made
250   - Includes files affected
2513. Follow the format and examples in this document
252 
253## Version History
254 
255- **v1.0** (2025-12-28): Initial git commit guidelines created
256