Skip to content

Instantly share code, notes, and snippets.

@sflandergan
sflandergan / AGENTS.md
Created January 16, 2026 10:03
AGENTS.md Template for Spring Boot Kotlin

Project structure

  • Use a domain-driven design approach
  • Keep track of the features in the AGENTS.md file (package, base URL, entities only)
  • Use a package by feature approach bundling rest controllers, services, repositories, models, configurations
    • Each feature MUST have its own dedicated package under com.deviceinsight.template.<feature-name>
    • NEVER mix features in the same package - each feature is completely self-contained
    • Package naming: use lowercase, plural or singular based on domain concept (e.g., devices, devicegroups, users, orders)
    • All feature code (controllers, services, repositories, DTOs, exceptions, configurations) goes in the feature package
    • Example: devices/ and devicegroups/ are separate packages, not mixed together
  • When creating a new feature, ALWAYS create a new package - do not add to existing feature packages
@sflandergan
sflandergan / AGENTS.md
Last active February 1, 2026 16:19
AGENTS.md Template for Spring Boot Java

Project structure

  • Use a domain-driven design approach
  • Keep track of the features in the AGENTS.md file (package, base URL, entities only)
  • Use a package by feature approach bundling rest controllers, services, repositories, models, configurations
    • Each feature MUST have its own dedicated package under com.deviceinsight.template.<feature-name>
    • NEVER mix features in the same package - each feature is completely self-contained
    • Package naming: use lowercase, plural or singular based on domain concept (e.g., devices, devicegroups, users, orders)
    • All feature code (controllers, services, repositories, DTOs, exceptions, configurations) goes in the feature package
    • Example: devices/ and devicegroups/ are separate packages, not mixed together
  • When creating a new feature, ALWAYS create a new package - do not add to existing feature packages