Skip to content

Commit 13b3921

Browse files
authored
chore(docs): sync CLAUDE.md with standardized template (#32)
- Add Microsoft coding guidelines reference (rule #8) - Standardize VSIX Development Rules section - Add perf and ci commit types to Conventional Commit Types table - Update build commands to use dotnet build (VsixSdk) - Update CI/CD section to reference correct workflow names
1 parent db1d177 commit 13b3921

1 file changed

Lines changed: 41 additions & 28 deletions

File tree

CLAUDE.md

Lines changed: 41 additions & 28 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,44 +70,25 @@ 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 extension that adds a right-click context menu command to open solution files, project files, or individual files in Notepad++. It targets .NET Framework 4.8 and uses the VS SDK.
8083

8184
## Build Commands
8285

83-
Build the extension (requires Visual Studio with VS SDK or .NET Framework 4.8 targeting pack):
84-
```
85-
msbuild src\CodingWithCalvin.OpenInNotepadPlusPlus.slnx
86+
```bash
87+
# Build the solution
88+
dotnet build src/CodingWithCalvin.OpenInNotepadPlusPlus/CodingWithCalvin.OpenInNotepadPlusPlus.csproj
89+
90+
# Build Release
91+
dotnet build src/CodingWithCalvin.OpenInNotepadPlusPlus/CodingWithCalvin.OpenInNotepadPlusPlus.csproj -c Release
8692
```
8793

8894
Debug by pressing F5 in Visual Studio - this launches the VS Experimental Instance (`/rootsuffix Exp`).
@@ -106,6 +112,13 @@ Path resolution in `ProjectHelpers.GetSelectedPath()` handles three selection ty
106112

107113
The extension auto-detects Notepad++ in the default install location but allows custom paths via Tools > Options.
108114

115+
## CI/CD
116+
117+
GitHub Actions workflows in `.github/workflows/`:
118+
119+
- **build.yml** - Triggered on push to main or PR. Builds and uploads VSIX artifact.
120+
- **publish.yml** - Manual trigger to publish to VS Marketplace.
121+
109122
## Development Requirements
110123

111124
Install the [Extensibility Essentials 2022](https://marketplace.visualstudio.com/items?itemName=MadsKristensen.ExtensibilityEssentials2022) extension for Visual Studio.

0 commit comments

Comments
 (0)