|
2 | 2 |
|
3 | 3 | This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository. |
4 | 4 |
|
| 5 | +## Critical Rules |
| 6 | + |
| 7 | +**These rules override all other instructions:** |
| 8 | + |
| 9 | +1. **NEVER commit directly to main** - Always create a feature branch and submit a pull request |
| 10 | +2. **Conventional commits** - Format: `type(scope): description` |
| 11 | +3. **GitHub Issues for TODOs** - Use `gh` CLI to manage issues, no local TODO files. Use conventional commit format for issue titles |
| 12 | +4. **Pull Request titles** - Use conventional commit format (same as commits) |
| 13 | +5. **Branch naming** - Use format: `type/scope/short-description` (e.g., `feat/ui/settings-dialog`) |
| 14 | +6. **Working an issue** - Always create a new branch from an updated main branch |
| 15 | +7. **Check branch status before pushing** - Verify the remote tracking branch still exists. If a PR was merged/deleted, create a new branch from main instead |
| 16 | +8. **WPF for all UI** - All UI must be implemented using WPF (XAML/C#). No web-based technologies (HTML, JavaScript, WebView) |
| 17 | + |
| 18 | +--- |
| 19 | + |
| 20 | +### GitHub CLI Commands |
| 21 | + |
| 22 | +```bash |
| 23 | +gh issue list # List open issues |
| 24 | +gh issue view <number> # View details |
| 25 | +gh issue create --title "type(scope): description" --body "..." |
| 26 | +gh issue close <number> |
| 27 | +``` |
| 28 | + |
| 29 | +### Conventional Commit Types |
| 30 | + |
| 31 | +| Type | Description | |
| 32 | +|------|-------------| |
| 33 | +| `feat` | New feature | |
| 34 | +| `fix` | Bug fix | |
| 35 | +| `docs` | Documentation only | |
| 36 | +| `refactor` | Code change that neither fixes a bug nor adds a feature | |
| 37 | +| `test` | Adding or updating tests | |
| 38 | +| `chore` | Maintenance tasks | |
| 39 | + |
| 40 | +--- |
| 41 | + |
5 | 42 | ## Project Overview |
6 | 43 |
|
7 | 44 | This is a Visual Studio 2022 extension (VSIX) called "Project Renamifier" that allows users to rename projects completely from within Visual Studio, including the filename, parent folder, namespace, and references in the solution file and other projects. |
@@ -53,38 +90,3 @@ Key points: |
53 | 90 | - Use meaningful, descriptive names |
54 | 91 | - Prefer `async`/`await` for asynchronous operations |
55 | 92 | - Use `ThreadHelper.ThrowIfNotOnUIThread()` when accessing VS services that require the UI thread |
56 | | - |
57 | | ---- |
58 | | - |
59 | | -## Workflow Rules |
60 | | - |
61 | | -**These rules must be followed:** |
62 | | - |
63 | | -1. **NEVER commit directly to main** - Always create a feature branch and submit a pull request. No exceptions. |
64 | | -2. **Conventional commits** - Format: `type(scope): description` |
65 | | -3. **GitHub Issues for TODOs** - Use `gh` CLI to manage issues; use conventional commit format for issue titles |
66 | | -4. **Pull Request titles** - Use conventional commit format (same as commits) |
67 | | -5. **Branch naming** - Use format: `type/scope/short-description` (e.g., `feat/rename/user-input-dialog`) |
68 | | -6. **Working an issue** - Always create a new branch from an updated main branch |
69 | | -7. **Check branch status before pushing** - Verify the remote tracking branch still exists; if a PR was merged/deleted, create a new branch from main |
70 | | -8. **No AI attribution in commits** - Do NOT include "Generated with Claude Code", "Co-Authored-By: Claude", or similar AI attribution lines in commit messages |
71 | | - |
72 | | -### GitHub Issues |
73 | | - |
74 | | -```bash |
75 | | -gh issue list # List open issues |
76 | | -gh issue view <number> # View details |
77 | | -gh issue create --title "feat(rename): add user input dialog" --body "..." |
78 | | -gh issue close <number> |
79 | | -``` |
80 | | - |
81 | | -### Conventional Commit Types |
82 | | - |
83 | | -| Type | Description | |
84 | | -|------|-------------| |
85 | | -| `feat` | New feature | |
86 | | -| `fix` | Bug fix | |
87 | | -| `docs` | Documentation only | |
88 | | -| `refactor` | Code change that neither fixes a bug nor adds a feature | |
89 | | -| `test` | Adding or updating tests | |
90 | | -| `chore` | Maintenance tasks | |
|
0 commit comments