diff --git a/.bot/README.md b/.bot/README.md new file mode 100644 index 0000000..2cfca89 --- /dev/null +++ b/.bot/README.md @@ -0,0 +1,10 @@ +# .bot Workspace + +This folder is reserved for local-only AI working material such as: + +- brainstorm notes +- draft implementation plans +- design alternatives +- temporary agent state + +Keep this folder out of source control. Move only finalized, non-confidential guidance into `AGENTS.md` or `.github/copilot-instructions.md`. diff --git a/.gitignore b/.gitignore index 51de915..0af61f5 100644 --- a/.gitignore +++ b/.gitignore @@ -373,4 +373,8 @@ FodyWeavers.xsd *.code-workspace # Strong-Name Key -*.snk \ No newline at end of file +*.snk + +# Bot workspace (local-only AI agent ideation, PRDs, and agentic loop state) +.bot/* +!.bot/README.md \ No newline at end of file diff --git a/.nuget/Codebelt.SharedKernel/PackageReleaseNotes.txt b/.nuget/Codebelt.SharedKernel/PackageReleaseNotes.txt index b9766b8..d74a52d 100644 --- a/.nuget/Codebelt.SharedKernel/PackageReleaseNotes.txt +++ b/.nuget/Codebelt.SharedKernel/PackageReleaseNotes.txt @@ -1,3 +1,9 @@ +Version: 0.5.8 +Availability: .NET 10 and .NET 9 + +# ALM +- CHANGED Dependencies have been upgraded to the latest compatible versions for all supported target frameworks (TFMs) + Version: 0.5.7 Availability: .NET 10 and .NET 9 diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..a12ca55 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,74 @@ +# Agent Instructions for Codebelt.SharedKernel + +This document provides guidance for AI agents working in this repository. + +## Project Overview + +Codebelt.SharedKernel is a foundational .NET library providing domain-driven design building blocks for time, correlation, tokens, and security concerns. The solution targets .NET 10.0, .NET 9.0, and .NET 8.0. It includes: + +- **Codebelt.SharedKernel** — Core types for temporal operations (ClockSkew, CoordinatedUniversalTime, TimeToLive), correlation tracking (CorrelationId), token management (Token, TokenOptions), and security (AccessKey, Secret). + +## Coding Standards + +- **Text encoding:** UTF-8 for text files (enforced via `.editorconfig`) +- **Template rewrites:** Preserve UTF-8 explicitly when scripts or tools rewrite text files; avoid locale-dependent encoding defaults +- **Namespaces:** File-scoped namespaces are required (enforced via `.editorconfig`) +- **Top-level statements:** Not allowed (enforced via `.editorconfig`) +- **Language version:** Always use the latest C# features (`LangVersion=latest`) +- **Nullable:** Enable nullable reference types in all new code +- **XML documentation:** All public APIs must have XML documentation comments +- **Testing:** Use xUnit v3 with Codebelt.Extensions.Xunit base classes + +## Project Structure + +- `src/` — Production source code + - `Codebelt.SharedKernel/` — Core domain types and building blocks + - Temporal operations (ClockSkew.cs, CoordinatedUniversalTime.cs, TimeToLive.cs) + - Correlation tracking (CorrelationId.cs) + - Token management (Token.cs, TokenOptions.cs) + - Security types (Security/AccessKey.cs, Security/Secret.cs) + - Value objects (ComparableValueObject.cs) +- `test/` — Unit and integration tests (project names end with `Tests`) + - `Codebelt.SharedKernel.Tests/` — Unit tests for all core types +- `.nuget/` — Per-package NuGet metadata (icon, README, release notes) +- `.docfx/` — DocFX documentation configuration +- `.github/` — CI/CD workflows, contributing guidelines, Copilot instructions + +## Test Conventions + +- Test project names must end with `Tests` (e.g., `{PROJECT_NAME}.Tests`) +- Test classes should inherit from the `Test` base class in `Codebelt.Extensions.Xunit` +- Use `Microsoft.Testing.Platform` as the test runner (`UseMicrosoftTestingPlatformRunner=true`) +- All tests are executable (`OutputType=Exe`) +- Test namespaces must match the SUT namespace (System Under Test), without `.Tests` suffix +- See `.github/copilot-instructions.md` for detailed test writing guidelines + +## Build & CI + +- Centralized package versions via `Directory.Packages.props` +- Resolve new or updated `Directory.Packages.props` versions from NuGet.org and keep them on the latest stable listed releases +- Centralized build configuration via `Directory.Build.props` +- MinVer for semantic versioning from Git tags +- Strong-name signing is enabled in CI environments (`CI=true`) +- Keep `.github/dependabot.yml` enabled at the repo root so central NuGet package management stays current + +## .bot/ Folder + +If a `.bot/` folder exists at the root, it contains **confidential, local-only** working material for AI agents — product requirement documents (PRDs), design proposals, agentic loop state, and brainstorming outputs. This folder is gitignored and never committed. + +When starting creative or design work (new features, architecture decisions, PRD drafts), use the [brainstorming skill](https://skills.sh/obra/superpowers/brainstorming) and save outputs to `.bot/`. Only move finalized, non-confidential instructions into `AGENTS.md` or `.github/copilot-instructions.md`. + +## Git Operations Safeguards + +Agents must never automatically commit code changes or push to remote repositories. Both actions require explicit user approval: + +- **Commits**: Always request confirmation from the user before staging and committing code. Present a clear summary of the changes and wait for approval before executing the commit. +- **Remote Operations**: Do not push, pull, fetch, or interact with `origin` or any remote repository without explicit user instruction. These operations modify repository history and can cause data loss if performed unexpectedly. + +**Rationale:** Automatic commits can clutter history with incomplete work, temporary debugging code, or unintended changes. Unexpected remote operations risk overwriting or losing commits on shared branches. Always require explicit user approval before performing these actions. + +## Official Documentation + +- Public API conventions belong in `.docfx/api/namespaces/` and should be treated as the official documentation source for library behavior and naming vocabulary. +- When adding or renaming public APIs, update the relevant namespace page in `.docfx/api/namespaces/` if the change introduces or clarifies a convention. +- Keep internal reasoning, exploratory notes, and agent discussion out of DocFX pages; summarize only stable public guidance. diff --git a/CHANGELOG.md b/CHANGELOG.md index fdbb8de..789c2a5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), For more details, please refer to `PackageReleaseNotes.txt` on a per assembly basis in the `.nuget` folder. +## [0.5.8] - 2026-06-06 + +This is a service update that focuses on package dependencies. + ## [0.5.7] - 2026-05-27 This is a patch release that improves test coverage, infrastructure resilience, and code quality through CI/CD enhancements, package updates, and developer guidance. diff --git a/Directory.Build.props b/Directory.Build.props index ddb649c..2220950 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -17,7 +17,7 @@ Copyright © Geekle 2024-2026. All rights reserved. gimlichael Geekle - Codebelt Shared Kernel (DDD) + Shared Kernel API by Codebelt icon.png README.md https://www.codebelt.net/ diff --git a/Directory.Packages.props b/Directory.Packages.props index 9b39265..43e78ea 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -3,13 +3,13 @@ true - - + + - - - + + +