diff --git a/.agents/_TOC.md b/.agents/_TOC.md index cf470cb..065df13 100644 --- a/.agents/_TOC.md +++ b/.agents/_TOC.md @@ -1,18 +1,16 @@ # Table of Contents 1. [Quick Reference Card](quick-reference-card.md) -2. [Purpose](purpose.md) -3. [Project overview](project-overview.md) -4. [Coding guidelines](coding-guidelines.md) -5. [Documentation & comments](documentation-guidelines.md) -6. [Documentation typography & structure](documentation-typography-and-structure.md) -7. [Documentation tasks](documentation-tasks.md) -8. [Running builds](running-builds.md) -9. [Version policy](version-policy.md) -10. [Project structure expectations](project-structure-expectations.md) -11. [Testing](testing.md) -12. [Safety rules](safety-rules.md) -13. [Advanced safety rules](advanced-safety-rules.md) -14. [Refactoring guidelines](refactoring-guidelines.md) -15. [Common tasks](common-tasks.md) -16. [Java to Kotlin conversion](java-kotlin-conversion.md) +2. [Project overview](project-overview.md) +3. [Coding guidelines](coding-guidelines.md) +4. [Documentation & comments](documentation-guidelines.md) +5. [Documentation tasks](documentation-tasks.md) +6. [Running builds](running-builds.md) +7. [Version policy](version-policy.md) +8. [Project structure expectations](project-structure-expectations.md) +9. [Testing](testing.md) +10. [Safety rules](safety-rules.md) +11. [Advanced safety rules](advanced-safety-rules.md) +12. [Refactoring guidelines](refactoring-guidelines.md) +13. [Common tasks](common-tasks.md) +14. [Java to Kotlin conversion](java-kotlin-conversion.md) diff --git a/.agents/project-overview.md b/.agents/project-overview.md index 69c58eb..dfac73f 100644 --- a/.agents/project-overview.md +++ b/.agents/project-overview.md @@ -2,7 +2,6 @@ - **Languages**: Kotlin (primary), Java (secondary). - **Build tool**: Gradle with Kotlin DSL. -- **Architecture**: Event-driven Command Query Responsibility Segregation (CQRS). - **Static analysis**: detekt, ErrorProne, Checkstyle, PMD. - **Testing**: JUnit 5, Kotest Assertions, Codecov. - **Tools used**: Gradle plugins, IntelliJ IDEA Platform, KSP, KotlinPoet, Dokka. diff --git a/.agents/project-structure-expectations.md b/.agents/project-structure-expectations.md index 1362a51..81b8e1a 100644 --- a/.agents/project-structure-expectations.md +++ b/.agents/project-structure-expectations.md @@ -16,6 +16,6 @@ buildSrc/ build.gradle.kts # Kotlin-based build configuration settings.gradle.kts # Project structure and settings README.md # Project overview -AGENTS.md # LLM agent instructions (this file) +AGENTS.md # Entry point for LLM agent instructions version.gradle.kts # Declares the project version. ``` diff --git a/.agents/purpose.md b/.agents/purpose.md deleted file mode 100644 index fb86526..0000000 --- a/.agents/purpose.md +++ /dev/null @@ -1,20 +0,0 @@ -# 🧠 Purpose - -> **EXECUTIVE SUMMARY**: This guide outlines how AI agents (ChatGPT, Codex, Junie, Claude, Gemini) -> collaborate on our Kotlin/Java project. It defines responsibilities, coding standards, -> and workflows to maintain high code quality and architectural integrity. - -It outlines: - -- Agent responsibilities (who does what). -- Coding and architectural guidelines agents must follow. -- Instructions for creating and testing agent-generated outputs. - -Whether you are a developer, tester, or contributor, this guide helps you collaborate -with AI to maintain a high-quality codebase. - -## Terminology -- **LLM**: Refers to the general category of language models (e.g., ChatGPT, Codex, Claude, Junie). -- **Agents**: A broader term for LLMs collaborating on this project. -- Use specific names (**ChatGPT**, **Codex**) when they excel at different tasks - (e.g., scaffolding versus explanation). diff --git a/.agents/refactoring-guidelines.md b/.agents/refactoring-guidelines.md index 818a13f..191db49 100644 --- a/.agents/refactoring-guidelines.md +++ b/.agents/refactoring-guidelines.md @@ -1,3 +1,3 @@ # ⚙️ Refactoring guidelines -- Do not replace Kotest assertions with standard Kotlin's Built-In Test Assertions. +- Do NOT replace Kotest assertions with standard Kotlin's built-in test assertions. diff --git a/.idea/inspectionProfiles/Project_Default.xml b/.idea/inspectionProfiles/Project_Default.xml index 229f1d3..0bd1d9d 100644 --- a/.idea/inspectionProfiles/Project_Default.xml +++ b/.idea/inspectionProfiles/Project_Default.xml @@ -255,18 +255,6 @@