Skip to content

Commit 844e6eb

Browse files
authored
chore(docs): sync CLAUDE.md with standardized template (#52)
1 parent d895fd5 commit 844e6eb

1 file changed

Lines changed: 36 additions & 41 deletions

File tree

CLAUDE.md

Lines changed: 36 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,32 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
1313
5. **Branch naming** - Use format: `type/scope/short-description` (e.g., `feat/ui/settings-dialog`)
1414
6. **Working an issue** - Always create a new branch from an updated main branch
1515
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)
16+
8. **Microsoft coding guidelines** - Follow [Microsoft C# coding conventions](https://learn.microsoft.com/en-us/dotnet/csharp/fundamentals/coding-style/coding-conventions) and [.NET library design guidelines](https://learn.microsoft.com/en-us/dotnet/standard/design-guidelines/)
17+
9. **WPF for all UI** - All UI must be implemented using WPF (XAML/C#). No web-based technologies (HTML, JavaScript, WebView)
18+
19+
---
20+
21+
### GitHub CLI Commands
22+
23+
```bash
24+
gh issue list # List open issues
25+
gh issue view <number> # View details
26+
gh issue create --title "type(scope): description" --body "..."
27+
gh issue close <number>
28+
```
29+
30+
### Conventional Commit Types
31+
32+
| Type | Description |
33+
|------|-------------|
34+
| `feat` | New feature |
35+
| `fix` | Bug fix |
36+
| `docs` | Documentation only |
37+
| `refactor` | Code change that neither fixes a bug nor adds a feature |
38+
| `test` | Adding or updating tests |
39+
| `chore` | Maintenance tasks |
40+
| `perf` | Performance improvement |
41+
| `ci` | CI/CD changes |
1742

1843
### VSIX Development Rules
1944

@@ -25,7 +50,7 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
2550

2651
**Build Configuration:**
2752
- Configurations: Debug and Release
28-
- Platform: AnyCPU
53+
- Platform: AnyCPU (or x64 where required)
2954
- Build Tools: Latest 17.* release
3055
- VSSDK: Latest 17.* release
3156

@@ -45,35 +70,13 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
4570

4671
**Development Environment:**
4772
- Required extension: Extensibility Essentials 2022
48-
- Helper library: VsixCommunity Toolkit
73+
- Helper library: Community.VisualStudio.Toolkit (where applicable)
4974

5075
**Documentation:**
5176
- README should be exciting and use emojis
5277

5378
---
5479

55-
### GitHub CLI Commands
56-
57-
```bash
58-
gh issue list # List open issues
59-
gh issue view <number> # View details
60-
gh issue create --title "type(scope): description" --body "..."
61-
gh issue close <number>
62-
```
63-
64-
### Conventional Commit Types
65-
66-
| Type | Description |
67-
|------|-------------|
68-
| `feat` | New feature |
69-
| `fix` | Bug fix |
70-
| `docs` | Documentation only |
71-
| `refactor` | Code change that neither fixes a bug nor adds a feature |
72-
| `test` | Adding or updating tests |
73-
| `chore` | Maintenance tasks |
74-
75-
---
76-
7780
## Project Overview
7881

7982
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.
@@ -83,10 +86,11 @@ This is a Visual Studio 2022 extension (VSIX) called "Project Renamifier" that a
8386
## Build Commands
8487

8588
```bash
86-
# Build the solution (from repo root)
87-
msbuild src/CodingWithCalvin.ProjectRenamifier/CodingWithCalvin.ProjectRenamifier.slnx
89+
# Build the solution
90+
dotnet build src/CodingWithCalvin.ProjectRenamifier/CodingWithCalvin.ProjectRenamifier.csproj
8891

89-
# Or open in Visual Studio and build (F5 to debug launches experimental VS instance)
92+
# Build Release
93+
dotnet build src/CodingWithCalvin.ProjectRenamifier/CodingWithCalvin.ProjectRenamifier.csproj -c Release
9094
```
9195

9296
## Development Setup
@@ -110,18 +114,9 @@ msbuild src/CodingWithCalvin.ProjectRenamifier/CodingWithCalvin.ProjectRenamifie
110114
- Commands registered via VSCT files and OleMenuCommandService
111115
- **Always use WPF for user interface** (dialogs, windows, etc.)
112116

113-
## Coding Standards
114-
115-
Follow Microsoft's official guidelines:
117+
## CI/CD
116118

117-
- [C# Coding Conventions](https://learn.microsoft.com/en-us/dotnet/csharp/fundamentals/coding-style/coding-conventions)
118-
- [.NET Design Guidelines](https://learn.microsoft.com/en-us/dotnet/standard/design-guidelines/)
119-
- [Framework Design Guidelines](https://learn.microsoft.com/en-us/dotnet/standard/design-guidelines/general-naming-conventions)
119+
GitHub Actions workflows in `.github/workflows/`:
120120

121-
Key points:
122-
- Use PascalCase for public members, types, namespaces, and methods
123-
- Use camelCase for private fields (prefix with `_` e.g., `_fieldName`)
124-
- Use `var` when the type is obvious from the right side of the assignment
125-
- Use meaningful, descriptive names
126-
- Prefer `async`/`await` for asynchronous operations
127-
- Use `ThreadHelper.ThrowIfNotOnUIThread()` when accessing VS services that require the UI thread
121+
- **build.yml** - Triggered on push to main or PR. Builds and uploads VSIX artifact.
122+
- **publish.yml** - Manual trigger to publish to VS Marketplace.

0 commit comments

Comments
 (0)