Skip to content

sumaris-pod: AI agent rules

Reference copy of sumaris-pod/.agents/rules (branch develop). These rules are written for AI coding agents; the developer guide summarizes them for human developers.

Rule Applies
cache When adding or modifying cache configuration, or using @Cacheable/@CacheEvict annotations
common Always applied
configuration-option When adding or modifying configuration options, caching configuration values, or using SumarisConfiguration
database-liquibase When creating or modifying Liquibase changelogs, database schemas, SQL scripts, or HSQLDB test data
elasticsearch When creating or modifying Elasticsearch repositories, specifications, VO indexing, or CRUD operations with Elasticsearch
fishbase When working with FishBase or SeaLifeBase species data schema, or using fishbase-species.r script
gitlab When performing GitLab operations (issues, merge requests, branches, reviews)
graphql-rest-api When creating or modifying GraphQL services, REST controllers, FilterVO, FetchOptions, or JSON serialization
i18n Always applied
jpa-entities-and-vos When creating or modifying JPA entities, Value Objects (VO), repositories, or entity-VO mappings
parquet-entities When creating or modifying Parquet repositories, Parquet Value Objects (VO), or using Parquet annotations
security-and-crypto When implementing authentication, authorization, access control, or cryptographic operations
service When creating or modifying business services, FilterVO, FetchOptions, or service implementations
unit-testing When writing or modifying unit tests, integration tests, or test data fixtures