267 lines
18 KiB
Markdown
267 lines
18 KiB
Markdown
<!--
|
||
GENERATED BY KRI AGENT HARNESS. DO NOT EDIT DIRECTLY.
|
||
Project: kri-common
|
||
Schema version: 1
|
||
Edit the source fragments or repository .agent files, then recompose.
|
||
-->
|
||
|
||
# KRI Development Base Instructions
|
||
|
||
This document defines the shared working rules for KRI development repositories.
|
||
Keep project-specific facts and commands in the project profile and project rules.
|
||
|
||
## Instruction Resolution
|
||
|
||
Apply repository instructions in this order:
|
||
|
||
1. Base rules
|
||
2. Project-type rules
|
||
3. Technology-stack rules
|
||
4. Shared consumer contracts
|
||
5. Project-specific rules
|
||
6. The explicitly approved task scope
|
||
|
||
Later and more specific instructions may override earlier general instructions only within their stated scope.
|
||
|
||
- Apply a shared consumer contract only when `.agent/profile.yml` declares it.
|
||
- Do not silently resolve a material instruction conflict. Report the conflicting rules and request a decision before changing files.
|
||
- Rules involving destructive actions, credentials, external systems, production, deployment, databases, or Git publication require explicit authorization even when a later rule is less restrictive.
|
||
|
||
## Communication
|
||
|
||
- Respond to the user in Korean unless the user requests another language.
|
||
- Keep code identifiers, commands, paths, protocol names, and external API terms in their original form.
|
||
- Follow the repository's existing language conventions for code comments and user-facing messages.
|
||
- Lead with the result or decision, then provide only the detail needed to verify it.
|
||
- Do not create or retain a full session transcript.
|
||
|
||
### Attention-Aware Response Style
|
||
|
||
- Use `attention-aware-communication` for substantive answers, progress updates, and completion reports.
|
||
- Default to concise, bottom-line-first Korean without omitting a condition, risk, number, or uncertainty needed for a correct decision.
|
||
- Give full detail when the user requests depth. Use Spartan style only when explicitly requested.
|
||
- Presentation rules never reduce investigation, implementation, validation, or reporting obligations.
|
||
|
||
## Work Authorization
|
||
|
||
- The default workflow is discussion first and explicit execution approval second.
|
||
- During discussion, perform only read-only investigation needed to understand the task and propose a concrete plan, unless the user prohibits inspection.
|
||
- Read-only investigation may include file inspection, code search, encoding checks, `git status`, `git diff`, `git log`, and sanitized official-documentation lookup.
|
||
- Before execution approval, do not edit files, install dependencies, run builds or tests, start services, connect to databases, or change local or external state.
|
||
- Before requesting approval, describe the intended scope, affected areas, validation plan, and material risks.
|
||
- Treat approval as limited to the presented scope. Pause and discuss again if the work materially expands.
|
||
- If the user explicitly requests immediate execution without prior discussion, the discussion gate may be skipped for the stated scope.
|
||
- Fast-track authorization does not implicitly authorize protected operations such as destructive commands, production changes, deployments, database mutations, Git publication, or external messages.
|
||
|
||
## Local Development Environment
|
||
|
||
- Primary OS: Windows 11.
|
||
- Primary shell: PowerShell.
|
||
- Use Git Bash only when the repository already depends on Bash or POSIX shell behavior.
|
||
- Prefer repository-provided wrappers and scripts over globally installed commands.
|
||
- Do not assume that GNU utilities, WSL, Docker, or a Unix-compatible shell are available unless the project profile confirms them.
|
||
- Detect Java, Node.js, .NET, Python, package-manager, and database-tool versions from repository configuration.
|
||
- Do not install or modify global toolchains as part of a project task.
|
||
|
||
Preferred human-facing tools:
|
||
|
||
- Classic ASP: Visual Studio Code
|
||
- Java and Spring Boot: IntelliJ IDEA
|
||
- C# and .NET: JetBrains Rider
|
||
- JavaScript, TypeScript, and Next.js: JetBrains WebStorm
|
||
- Python: JetBrains PyCharm
|
||
- Microsoft SQL Server: SQL Server Management Studio
|
||
- Other databases: JetBrains DataGrip
|
||
|
||
- These preferences do not authorize launching or controlling a GUI application.
|
||
- Prefer IDE-independent commands that can also run in CI.
|
||
- Do not modify global IDE settings.
|
||
- Do not create or modify `.idea`, `.vscode`, workspace, or run-configuration files unless the approved task requires it.
|
||
- Preserve existing shared IDE configuration when it is already tracked.
|
||
|
||
## PowerShell and Path Safety
|
||
|
||
- Quote paths containing spaces, brackets, parentheses, Korean characters, or PowerShell metacharacters.
|
||
- Prefer `-LiteralPath` when operating on an exact filesystem path.
|
||
- Use project-relative paths in committed configuration and documentation. Do not commit machine-specific paths such as `D:\_____Dev\...`.
|
||
- Do not pass filesystem targets between PowerShell, `cmd.exe`, and Bash for destructive or recursive operations.
|
||
- Keep a filesystem operation within one shell from target resolution through execution.
|
||
- Before a recursive delete or move, resolve and verify every absolute target.
|
||
- Never use a drive root, workspace root, user profile, unresolved variable, wildcard, or broad glob as a recursive delete target.
|
||
- Prefer recoverable operations when practical.
|
||
|
||
## Change Discipline
|
||
|
||
- Preserve all existing user changes, including uncommitted and untracked work.
|
||
- Keep changes minimal but complete for the approved objective.
|
||
- Avoid unrelated cleanup, formatting, renaming, dependency upgrades, and architectural refactoring.
|
||
- Do not overwrite or revert unrelated changes.
|
||
- Stop and report when the requested change overlaps existing work in a way that cannot be handled safely.
|
||
- Prefer changing an authoritative source over editing generated output.
|
||
- Treat files marked as generated as read-only unless regeneration is part of the approved plan.
|
||
- Do not edit vendored dependencies, build outputs, caches, or generated clients unless explicitly required.
|
||
- Do not regenerate a broad set of files for a narrow change without first explaining the expected output scope.
|
||
|
||
## Text Encoding and Korean Content Safety
|
||
|
||
- Treat the existing file encoding, BOM state, and line-ending style as part of the file's contract.
|
||
- Preserve Korean comments, user-facing messages, error messages, identifiers, and documentation exactly unless the task explicitly requires changing them.
|
||
- Do not assume that garbled terminal output means the file itself is corrupted. Verify bytes and encoding before modifying suspicious text.
|
||
- Before editing an existing text file, determine its current encoding and BOM state when repository configuration does not already guarantee them.
|
||
- Do not convert encoding, add or remove a BOM, or normalize line endings as a side effect of an unrelated change.
|
||
- Avoid whole-file rewrites for small changes.
|
||
- Do not rewrite source files through `Get-Content | Set-Content`, `Out-File`, shell redirection, or another method whose encoding behavior is implicit.
|
||
- Do not use a patching or formatting tool on a non-UTF-8 file unless it is known to preserve that file's encoding.
|
||
- Treat a console display problem and an on-disk encoding problem as separate issues.
|
||
- After editing Korean text, inspect the diff for replacement characters (`<60>`), mojibake, unexpected escapes, BOM changes, and unrelated line-ending changes.
|
||
- Run `.agent/tools/check-encoding.ps1` when it is available and the change touches Korean text or a non-default encoding.
|
||
- If encoding cannot be identified confidently, stop before writing and report the affected file and evidence.
|
||
- For a new text file, follow repository configuration. If no rule exists, use UTF-8 without BOM.
|
||
|
||
## Git Safety
|
||
|
||
- Use `git status`, `git diff`, and `git log` for read-only investigation.
|
||
- Do not run `commit`, `push`, `pull`, `fetch`, `merge`, `rebase`, `reset`, `checkout`, `switch`, `stash`, `clean`, `tag`, or force operations unless that specific operation is explicitly approved.
|
||
- Source-edit approval does not include commit or push approval.
|
||
- Never amend an existing commit unless explicitly requested.
|
||
- Before an approved commit, show the intended files, validation results, and proposed commit message.
|
||
- Never push directly to a protected branch unless the user names the target branch and explicitly authorizes the push.
|
||
|
||
## Dependencies and External Actions
|
||
|
||
- Use the package manager, lockfile, and toolchain already selected by the repository.
|
||
- Do not install global packages.
|
||
- Do not add, remove, or upgrade a dependency unless it was included in the approved plan.
|
||
- Pause for approval if an unplanned dependency becomes necessary.
|
||
- Keep lockfiles synchronized with approved dependency changes.
|
||
- Do not deploy, publish packages, create releases, send messages or email, call business APIs, or modify external services unless explicitly requested.
|
||
- Never upload proprietary source code, internal documents, credentials, customer data, or database contents to an external service.
|
||
- Remove secrets and unnecessary internal identifiers from external search queries.
|
||
|
||
## Database Safety
|
||
|
||
- Treat writing or reviewing SQL as source code separately from executing SQL against a database.
|
||
- SQL files, migrations, schema proposals, and query drafts may be created within an approved source-change scope.
|
||
- Do not connect to a shared, staging, or production database without explicit authorization for that environment.
|
||
- Read-only queries against a non-local database also require authorization because results may contain sensitive data.
|
||
- Do not execute DDL, DML, stored procedures, migrations, administrative commands, or data-correction scripts against a non-disposable database without separate authorization for the exact target and operation.
|
||
- Source-change approval does not authorize migration execution.
|
||
- Use a disposable local or test database for approved validation only after verifying its identity and disposable nature.
|
||
- Never place credentials, connection strings, or sensitive query results in source files, logs, generated documents, or chat output.
|
||
|
||
## Secrets and Sensitive Data
|
||
|
||
- Never add credentials, tokens, passwords, private keys, connection strings, session identifiers, or production data to source control.
|
||
- Read sensitive files only when the approved task requires it and no safer source exists.
|
||
- Prefer inspecting configuration keys and schemas without displaying secret values.
|
||
- Never echo secrets into terminal output, chat responses, logs, diffs, generated documents, test fixtures, or screenshots.
|
||
- Redact sensitive values when reporting errors or command output.
|
||
- If a possible secret is discovered, do not repeat it. Report only its location, type, and recommended containment action.
|
||
- Do not rotate, revoke, copy, or otherwise modify credentials unless that exact action is explicitly authorized.
|
||
|
||
## Workflow Skills
|
||
|
||
- Use `project-reference-loader` before substantive repository analysis, planning, implementation, debugging, or review. Read only the current project and shared references routed for that task, and reread them for each related task even if they were loaded earlier in the session.
|
||
- Use `karpathy-guidelines` when implementing, refactoring, or reviewing code. It keeps assumptions visible, changes surgical, and success criteria verifiable.
|
||
- Use `verification-before-completion` before claiming that work is complete, fixed, passing, ready, or safe to commit or publish.
|
||
- A skill does not expand task scope or authorize Git publication, database execution, deployment, destructive actions, or external communication.
|
||
|
||
## Validation
|
||
|
||
- Discover supported build, test, lint, type-check, and formatting commands from repository files and project instructions. Do not invent commands.
|
||
- Include intended validation in the discussion-phase plan.
|
||
- After approved changes, run the narrowest relevant validation first, then broader checks when appropriate.
|
||
- Limit formatting to files within the approved scope.
|
||
- Do not run tests that require a shared database, production service, paid external API, or sensitive data unless separately authorized.
|
||
- Do not claim that a check passed unless it was executed successfully.
|
||
- If a check cannot be run, state the exact reason.
|
||
- Distinguish a current-change failure from a pre-existing failure or an undetermined failure.
|
||
- Do not fix unrelated failures without expanding the approved scope.
|
||
- Inspect the worktree after validation for unexpected generated files, formatting churn, encoding changes, or lockfile changes.
|
||
|
||
## Artifacts and Session Records
|
||
|
||
- Do not create full-session transcripts, automatic HTML copies, analysis reports, or extra documentation unless explicitly requested.
|
||
- Store durable information in the repository's existing documentation structure.
|
||
- Do not place generated reports or temporary analysis files in the repository root.
|
||
- Remove task-specific temporary files created by the current task after validation when removal is safe.
|
||
|
||
## Completion Report
|
||
|
||
When implementation is complete, report in Korean:
|
||
|
||
- what changed and why;
|
||
- the main affected files or components;
|
||
- validation commands actually executed and their results;
|
||
- checks not executed and the reason;
|
||
- remaining risks, assumptions, or follow-up work;
|
||
- database, deployment, dependency, encoding, and compatibility impact when applicable.
|
||
|
||
- Do not report completion while required validation is failing or known encoding corruption is unresolved.
|
||
- Keep the report concise and do not include a full session transcript.
|
||
|
||
## Library Project Rules
|
||
|
||
- Treat exported code, configuration keys, registry schemas, generated artifacts, package coordinates, and documented behavior as consumer-facing contracts.
|
||
- Before changing a public surface, classify the change as internal, backward-compatible, deprecating, or breaking.
|
||
- Do not remove, rename, relocate, or materially change a public API without an approved compatibility and migration plan.
|
||
- Preserve consumer override points and optional integrations.
|
||
- Do not make an optional peer, compile-only, or runtime dependency mandatory without reviewing consumer impact.
|
||
- Prefer additive evolution and deprecation over immediate removal.
|
||
- When a public contract changes, update tests, human documentation, and the library's consumer contract in the same approved change.
|
||
- Validate both the source and the distributable artifact when supported.
|
||
- Inspect known consumers when available, but do not modify consumer repositories unless they are included in the approved scope.
|
||
- Version changes, publication, registry deployment, and package replacement require separate authorization.
|
||
- Keep repository-maintainer rules in `.agent/project.md` and downstream usage rules in `.agent/consumer.md`.
|
||
|
||
## Java and Spring Boot
|
||
|
||
- Treat the configured JDK, Spring Boot, Gradle, plugin, dependency, and package versions as authoritative.
|
||
- Use the repository's Gradle Wrapper. Do not substitute a machine-global Gradle installation.
|
||
- Preserve the established package layout and controller, application/service, domain, and persistence boundaries.
|
||
- Keep controllers thin, place business rules in the established service/domain layer, and prefer constructor injection.
|
||
- Apply request and configuration validation at boundaries and preserve the project's exception and response conventions.
|
||
- Make transaction boundaries explicit and narrow; do not add broad transactions to hide lifecycle or query problems.
|
||
- Preserve authentication, authorization, auditing, logging, and secret-management conventions.
|
||
- Do not edit generated QueryDSL or other generated sources. Change their source definitions and regenerate only when the repository workflow requires it.
|
||
- Use the approved KriCommon contract when the project profile includes it; do not duplicate shared backend behavior locally.
|
||
- Run the narrowest relevant Gradle compile, test, static-analysis, and build tasks.
|
||
|
||
## KriCommon Consumer Contract
|
||
|
||
- Consume KriCommon as `com.kri.common:starter:<approved-version>` through the repository's established Gradle version-management convention.
|
||
- Import service-facing APIs from `com.kri.common.feature.*`; treat `com.kri.common.runtime.*` as internal.
|
||
- Prefer a shared feature or approved extension point over duplicating authentication, HTTP, error, enum, Excel, Redis, JSON, date/time, JPA, crypto, or utility behavior locally.
|
||
- Do not modify KriCommon or another consumer repository unless it is explicitly included in the approved task scope.
|
||
|
||
### Required Shared References
|
||
|
||
Before each related task, read the current contents of every matching reference, even if it was read earlier in the session.
|
||
|
||
| Task scope | Required reference |
|
||
|---|---|
|
||
| Dependency, configuration, security, Web, Swagger, Redis, scheduling, HTTP, JSON, or date/time behavior | `.agent-harness/references/kri-common/platform-capabilities.md` |
|
||
| Encryption, hashing, key material, or legacy crypto interoperability | `.agent-harness/references/kri-common/crypto-contract.md` |
|
||
| KriCommon version upgrade or consumer verification | `.agent-harness/references/kri-common/upgrade-and-verification.md` |
|
||
|
||
If a task spans multiple scopes, read every matching reference. Generated files under `.agent-harness/references/` are read-only copies; edit KriCommon's `.agent/consumer.md` or `.agent/consumer-references/` and recompose instead.
|
||
|
||
# KriCommon Project Instruction Router
|
||
|
||
## Required Project References
|
||
|
||
Before each related task, read the current contents of every matching reference below, even if it was read earlier in the session.
|
||
|
||
| Task scope | Required reference |
|
||
|---|---|
|
||
| Any substantive analysis, planning, implementation, debugging, review, or documentation work in this repository | `.agent/references/repository-rules.md` |
|
||
|
||
If a task spans multiple scopes, read every matching reference. Do not assume remembered content is current.
|
||
|
||
## Harness Workflow
|
||
|
||
- `AGENTS.md` and `CLAUDE.md` are generated outputs. Never edit them directly.
|
||
- Edit `.agent/project.md` only when routing changes. Store durable project detail in `.agent/references/`.
|
||
- A reference-only content change does not require recomposition when its route is unchanged. Run harness verification to validate routing and UTF-8.
|
||
- Recompose and verify after changing `.agent/project.md`, `.agent/profile.yml`, or another composed instruction source.
|