Skip to content

Maintenance: introduce documentation, steering files and coding standards for Agents #1117

@hjgraca

Description

@hjgraca

Summary

Adding agents steering files for Kiro, Claude, GitHub

Project Architecture and Usage Documentation

  • Added .github/copilot-instructions.md with an overview of the Powertools architecture, AOP implementation details, build/test commands, conventions for AOT compatibility, thread safety, async patterns, file organization, testing, security, and references to key files.

C# and .NET Coding Standards

  • Introduced .github/instructions/csharp.instructions.md specifying C# naming conventions, type safety, async/await patterns, error handling, thread safety, AWS SDK usage, and documentation requirements for all C# files.
  • Added .github/instructions/dotnet-architecture-good-practices.instructions.md outlining SOLID principles, clean architecture layering, design patterns (AOP, singleton, builder), modern C# features, AOT compatibility, implementation checklist, and anti-patterns to avoid for C# and project files.

Example Code Guidelines

  • Created .github/instructions/examples.instructions.md to enforce production-ready standards for example code, including handler patterns, configuration, error handling, testing, documentation, realistic data, and performance best practices for files in examples/**/*.cs.

Why is this needed?

introduces documentation, steering files and coding standards for the Powertools for AWS Lambda (.NET) project. It adds a detailed architecture overview, developer instructions, and file-specific guidelines to ensure code quality, maintainability, and production readiness across all libraries and examples.

Which area does this relate to?

No response

Solution

No response

Acknowledgment

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationinternalMaintenance changes

Type

No type

Projects

Status

✅ Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions