From 35e3658413a423466e7f845d74e66107856375e6 Mon Sep 17 00:00:00 2001 From: "Calvin A. Allen" Date: Fri, 2 Jan 2026 22:05:09 -0500 Subject: [PATCH] chore(docs): sync CLAUDE.md with standardized template - Add Microsoft coding guidelines reference (rule #8) - Standardize VSIX Development Rules section - Add perf and ci commit types to Conventional Commit Types table - Preserve project-specific content (Overview, Build, Architecture) --- CLAUDE.md | 68 +++++++++++++++++++++++++++---------------------------- 1 file changed, 33 insertions(+), 35 deletions(-) diff --git a/CLAUDE.md b/CLAUDE.md index cc9cf68..d49bea2 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -13,7 +13,32 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co 5. **Branch naming** - Use format: `type/scope/short-description` (e.g., `feat/ui/settings-dialog`) 6. **Working an issue** - Always create a new branch from an updated main branch 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 -8. **WPF for all UI** - All UI must be implemented using WPF (XAML/C#). No web-based technologies (HTML, JavaScript, WebView) +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/) +9. **WPF for all UI** - All UI must be implemented using WPF (XAML/C#). No web-based technologies (HTML, JavaScript, WebView) + +--- + +### GitHub CLI Commands + +```bash +gh issue list # List open issues +gh issue view # View details +gh issue create --title "type(scope): description" --body "..." +gh issue close +``` + +### Conventional Commit Types + +| Type | Description | +|------|-------------| +| `feat` | New feature | +| `fix` | Bug fix | +| `docs` | Documentation only | +| `refactor` | Code change that neither fixes a bug nor adds a feature | +| `test` | Adding or updating tests | +| `chore` | Maintenance tasks | +| `perf` | Performance improvement | +| `ci` | CI/CD changes | ### VSIX Development Rules @@ -25,7 +50,7 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co **Build Configuration:** - Configurations: Debug and Release -- Platform: AnyCPU +- Platform: AnyCPU (or x64 where required) - Build Tools: Latest 17.* release - VSSDK: Latest 17.* release @@ -45,35 +70,13 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co **Development Environment:** - Required extension: Extensibility Essentials 2022 -- Helper library: VsixCommunity Toolkit +- Helper library: Community.VisualStudio.Toolkit (where applicable) **Documentation:** - README should be exciting and use emojis --- -### GitHub CLI Commands - -```bash -gh issue list # List open issues -gh issue view # View details -gh issue create --title "type(scope): description" --body "..." -gh issue close -``` - -### Conventional Commit Types - -| Type | Description | -|------|-------------| -| `feat` | New feature | -| `fix` | Bug fix | -| `docs` | Documentation only | -| `refactor` | Code change that neither fixes a bug nor adds a feature | -| `test` | Adding or updating tests | -| `chore` | Maintenance tasks | - ---- - ## Project Overview VS-BreakpointNotifier is a Visual Studio 2022 extension (VSIX) that displays a message box notification when a breakpoint is hit during debugging. This helps developers who are multi-tasking while waiting for breakpoints to trigger. @@ -81,14 +84,11 @@ VS-BreakpointNotifier is a Visual Studio 2022 extension (VSIX) that displays a m ## Build Commands ```bash -# Restore NuGet packages -nuget restore src/CodingWithCalvin.BreakpointNotifier.slnx +# Build the solution +dotnet build src/CodingWithCalvin.BreakpointNotifier/CodingWithCalvin.BreakpointNotifier.csproj -# Build Release (AnyCPU) -msbuild src/CodingWithCalvin.BreakpointNotifier/CodingWithCalvin.BreakpointNotifier.csproj /p:configuration=Release /p:platform=AnyCPU /p:DeployExtension=False - -# Build Debug (AnyCPU) -msbuild src/CodingWithCalvin.BreakpointNotifier/CodingWithCalvin.BreakpointNotifier.csproj /p:configuration=Debug /p:platform=AnyCPU /p:DeployExtension=False +# Build Release +dotnet build src/CodingWithCalvin.BreakpointNotifier/CodingWithCalvin.BreakpointNotifier.csproj -c Release ``` Output: `bin\{Configuration}\CodingWithCalvin.BreakpointNotifier.vsix` @@ -119,7 +119,5 @@ The extension has a minimal architecture with two core files: GitHub Actions workflows in `.github/workflows/`: -- **release_build_and_deploy.yml** - Triggered on push to main or PR. Versions, builds, and uploads VSIX artifact. +- **build.yml** - Triggered on push to main or PR. Versions, builds, and uploads VSIX artifact. - **publish.yml** - Manual trigger to publish to VS Marketplace and create GitHub release. - -Versioning is automated via `CodingWithCalvin/GHA-VSVsixVersioner` action.