Files
intranet-extension/.agent/references/repository-rules.md

2.4 KiB

IntranetExtension Repository Rules

Repository Role and Boundaries

  • This repository is a Java 17 Spring Boot shared service for intranet project, user, and telephone-number lookup APIs.
  • Treat request and response DTOs, endpoint paths, query semantics, error responses, authentication behavior, and caller-facing defaults as contracts used by other projects.
  • Preserve the established controller, service, mapper, configuration, DTO, and persistence boundaries. Keep controllers thin and place query orchestration and business rules in services.
  • Consume KriCommon through com.kri.common:starter:beta.1.6.3. Do not change that approved version or duplicate a KriCommon feature without separate explicit approval.

Persistence Safety

  • The primary intranet data source is MSSQL and uses the repository's MyBatis conventions. The MySQL JPA data source is limited to KriCommon API-key authentication data.
  • Do not mix the two data-source dialects, transactions, entities, repositories, or configuration paths.
  • Preserve mapper parameter names, result mappings, stored-procedure or query result shapes, null behavior, and ordering relied on by consumers.
  • Treat authentication data as read-only. Do not add writes to the API-key data source without separate explicit approval.
  • Do not execute SQL, migrations, stored procedures, or data corrections as part of source-code validation.

API and Security Safety

  • Preserve authentication, authorization, validation, allowlists, response conventions, and sensitive-data masking when changing an endpoint.
  • Minimize returned personal and organizational data. Never log credentials, API keys, user identifiers in bulk, telephone numbers, or complete request and response bodies containing sensitive data.
  • Prefer backward-compatible endpoint and DTO evolution. Report affected consumers and rollback considerations for any externally visible change.

Documentation and Verification

  • AGENTS.md and CLAUDE.md are harness-generated outputs. Never edit either file directly; edit .agent/project.md or .agent/profile.yml and recompose instead.
  • Use the repository Gradle Wrapper and run .\gradlew.bat compileJava on Windows for relevant changes, followed by focused tests when safe.
  • Do not start the service, connect to real databases, or call intranet business endpoints during validation without separate explicit approval.