mic-check/CLAUDE.original.md

CLAUDE.md

Guidance for Claude Code (claude.ai/code) when working in this repo.

Project

MicCheck: open source. asp.net, c#, typescript, VueJS. Manages feature flags, projects, environments.

Planned Structure

• src/admin/ — VueJS admin components
• src/api/ - .NET API + REST endpoints
• tests/ — test suite
• docs/ — documentation

Best Practices

• Use latest LTS .NET + latest supported nuget packages for that version
• Set langVersion to latest in all csproj files; enable nullable
• Organize code by feature/area, not type (e.g. features namespace)
• New features need unit tests covering as much logic as possible (both nunit and jest)
• Any modified file: evaluate for missing test coverage and that all tests pass

Coding

• Descriptive names for all classes/methods. No generic names: Provider, Manager, Helper
• Match formatting/style from .editorconfig
• Wrap lines at 220 characters, leave single line if fewer
• Place interfaces that are implemented by a single class at the bottom of the class file. An interface with multiple implementations of an interface should be in a seperate file.
• Do not use tuples for return types. Prefer records or classes for multiple values
• Do not use sealed
• Use record for data objects, class for objects with behavior. Avoid mutable state where possible.

Testing

• Require a minimum of 70% code coverage with a target of 90%. Unit tests should focus on end-user scenarios first.
• Do not write tests for just to increase code coverage. Call out lack of test coverage rather than covering something that isn't valuable to the end user.
• Code that can not be cleanly unit tested should be marked with [ExcludeFromCodeCoverage] or have it's namespace excluded from code coverage.
• BDD-style unit tests, end-to-end as possible, no external resources (DB, filesystem). e.g. WhenAUserDoesSomething_ThenAThingAppears
• Mock external deps with Moq
• Mock EntityFramework DBContexts with an extracted interface and Moq. Do not rely on InMemory provider.
• New features need unit tests covering as much logic as possible
• Any modified file: evaluate for missing test coverage-
• No "Mock" in mocked object names
• No Arrange/Act/Assert comments
• All tests should pass before commit

Claude

• Plans = .md files in docs/plans/. Admin → docs/plans/admin/, API → docs/plans/api/
• Split large plans into discrete chunks — each buildable + committable independently
• Plan generated from docs/plans/<name>.md → save as docs/plans/<name>_plan.md
• Plan implemented from docs/plans/<name>.md → save summary as docs/plans/<name>_output.md

Stack

.gitignore configured for .NET/Visual Studio (C#, NuGet, MSBuild). Update if stack changes.