- CLAUDE.md: repo-specific tech stack, commands, deps (points to root) - LICENSE: MIT 2026 svrnty (standardized) - CONTRIBUTING.md: unified workflow, correct co-author email - SECURITY.md: unified vulnerability reporting policy - CHANGELOG.md: Keep a Changelog template (if new) - lefthook.yml: added doc-hygiene hook, improved bootstrap Co-Authored-By: Svrnty Inc. <jp@svrnty.io>
48 lines
1.5 KiB
Markdown
48 lines
1.5 KiB
Markdown
# Development Guidelines
|
|
|
|
> **Source of truth**: All engineering principles, commit rules, documentation standards, and governance policies are defined in the [root CLAUDE.md](../CLAUDE.md). This file contains repo-specific notes only.
|
|
|
|
## Quick Reference
|
|
|
|
- **Branch**: `JP` for active development
|
|
- **Commit format**: `type(scope): message`
|
|
- **Co-Author**: `Co-Authored-By: Svrnty Inc. <jp@svrnty.io>`
|
|
- **Hooks**: `lefthook install` — enforces author, secrets, doc hygiene
|
|
- **Docs required**: README.md, CHANGELOG.md, LICENSE, CONTRIBUTING.md, SECURITY.md
|
|
|
|
## Tech Stack
|
|
|
|
| Tool | Version |
|
|
|------|---------|
|
|
| C# | 14 |
|
|
| .NET | 10.0 |
|
|
| AOT | enabled (IsAotCompatible=true) |
|
|
| Nullable | enabled |
|
|
|
|
## Commands
|
|
|
|
| Command | Description |
|
|
|---------|-------------|
|
|
| `dotnet build` | Build all 18 projects |
|
|
| `dotnet test` | Run tests |
|
|
| `dotnet format` | Format code |
|
|
|
|
## Key Dependencies
|
|
|
|
| Package | Description |
|
|
|---------|-------------|
|
|
| Svrnty.CQRS.Core | Core CQRS abstractions |
|
|
| Svrnty.CQRS.DynamicQuery | Dynamic query support |
|
|
| Svrnty.CQRS.gRPC | gRPC transport |
|
|
| Svrnty.CQRS.Events | Event sourcing |
|
|
| Svrnty.CQRS.Sagas | Saga orchestration |
|
|
| Svrnty.CQRS.Notifications | Notification handlers |
|
|
| Svrnty.CQRS.MinimalApi | Minimal API bindings |
|
|
|
|
## Repo-Specific Notes
|
|
|
|
- Solution file: `Svrnty.CQRS.sln` with 18 projects.
|
|
- Lint is handled by .NET analyzers — AOT compatibility and nullable reference types are enforced.
|
|
- No Docker or proto files in this repo.
|
|
- Published under the `svrnty` org (git.openharbor.io/svrnty), not `a-gent`.
|