274 lines
19 KiB
Markdown
274 lines
19 KiB
Markdown
<!--
|
||
GENERATED BY KRI AGENT HARNESS. DO NOT EDIT DIRECTLY.
|
||
Project: kri-ui-registry
|
||
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.
|
||
|
||
## 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.
|
||
|
||
## 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`.
|
||
|
||
## TypeScript
|
||
|
||
- Treat the repository's current TypeScript version, `tsconfig` files, module system, path aliases, and package manager as authoritative.
|
||
- Preserve or strengthen existing strictness. Do not weaken compiler options or hide errors with broad `any`, `@ts-ignore`, or unsafe assertions.
|
||
- Prefer narrow domain types, discriminated unions, and explicit boundary types over duplicated or overly generic shapes.
|
||
- Validate untrusted runtime input even when a compile-time type exists.
|
||
- Keep imports, exports, aliases, and generated-code boundaries consistent with the repository.
|
||
- Do not introduce a JavaScript-to-TypeScript conversion outside the approved scope.
|
||
- Run the repository's focused type-check, lint, test, and build commands as applicable.
|
||
|
||
## React
|
||
|
||
- Treat the current React version, component style, state management, routing, styling, and test approach as authoritative.
|
||
- Do not perform unrelated class-to-hook, JavaScript-to-TypeScript, state-library, styling-system, or React-to-Next.js migrations.
|
||
- Keep components focused and follow the repository's established split between presentation, state, data access, and side effects.
|
||
- Keep effects dependency-correct and clean up subscriptions, timers, listeners, and in-flight work where applicable.
|
||
- Use stable semantic keys and preserve accessibility, loading, empty, error, disabled, and success states.
|
||
- Preserve public component props and shared UI contracts unless a coordinated breaking change is explicitly approved.
|
||
- Treat any planned Next.js migration as a separate policy and task; the current React application remains authoritative until that migration slice is approved.
|
||
|
||
## KriUiRegistry Consumer Contract
|
||
|
||
### UI Component Selection
|
||
|
||
When implementing or changing frontend UI, use this order:
|
||
|
||
1. Reuse an existing shared component in the project when it already meets the requirement.
|
||
2. Prefer an approved component from KriUiRegistry.
|
||
3. Otherwise, prefer a suitable shadcn/ui component.
|
||
4. Create a new custom component only when the preceding options cannot meet the requirement without an unsafe or misleading adaptation.
|
||
|
||
### Installation and Ownership
|
||
|
||
- Inspect the registry item and its dependencies before installation. Use the shadcn CLI with the approved registry endpoint under `https://ui-registry.kric.com/r/` instead of copying files from `dist/r` manually.
|
||
- `kri-data-table` uses the TanStack Table v8 API. Keep `@tanstack/react-table` within the supported `^8.21.3` range and do not upgrade it to v9 until KriUiRegistry provides an explicitly migrated component contract.
|
||
- Respect the consumer project's component aliases, target paths, package manager, styling system, React version, and existing design tokens.
|
||
- The shadcn workflow copies component source into the consumer repository. After installation, treat that copy as project-owned code; do not assume registry updates propagate automatically.
|
||
- Do not overwrite an existing project component without reviewing the diff and confirming that local behavior and accessibility are preserved.
|
||
- Keep package and lockfile changes produced by an installation within the approved scope.
|
||
|
||
### Adaptation and Verification
|
||
|
||
- Adapt business data and application behavior outside the shared component when possible. Avoid embedding project-specific API, route, authentication, or environment logic into a reusable component.
|
||
- Preserve the installed component's public props, accessibility, keyboard behavior, responsive layout, and loading, empty, error, and disabled states unless the task explicitly changes them.
|
||
- If the registry lacks a generally reusable capability, propose it in KriUiRegistry; do not modify that repository unless it is explicitly in scope.
|
||
- Run the consumer repository's focused type-check, lint, tests, and build after installation or upgrade.
|
||
|
||
## KriUiRegistry Repository Rules
|
||
|
||
### Repository Role and Sources
|
||
|
||
- This repository is the internal shadcn registry named `kri`, published from `https://ui-registry.kric.com`.
|
||
- `registry.json`, `registry/components/registry.json`, and the files under `registry/` are source inputs. `dist/r` is generated output and must not be edited directly.
|
||
- Treat registry item names, targets, dependencies, registry dependencies, component props, behavior, styling tokens, and the public registry URL as consumer-facing contracts.
|
||
- Preserve shadcn registry schema compatibility and keep every item self-contained enough for the shadcn CLI to install it into a consumer project.
|
||
|
||
### Component and Metadata Rules
|
||
|
||
- Prefer accessible shadcn/Radix composition and the registry's existing component patterns before introducing a new abstraction.
|
||
- Keep project-specific business rules, API clients, routes, credentials, and environment assumptions out of registry components.
|
||
- Use portable design tokens and styles. Do not introduce project-only `content-text-*` classes or imports from `@kri/common/ui`; the repository verifier rejects them.
|
||
- Declare all package dependencies and registry dependencies accurately. Keep item file targets stable unless an approved migration covers consumers.
|
||
- Preserve loading, empty, error, disabled, keyboard, focus, and screen-reader behavior when changing an interactive component.
|
||
- Avoid embedding generated files or consumer-local configuration in registry source items.
|
||
|
||
### Verification and Release Boundary
|
||
|
||
- Use the committed lockfile and run `npm run build`, followed by `npm run verify`, for registry changes.
|
||
- Inspect the generated item JSON when changing files, dependencies, item names, or targets.
|
||
- Update `.agent/consumer.md` and human documentation in the same approved change when installation or component-selection behavior changes.
|
||
- Registry publication, deployment, version changes, and consumer-repository updates require separate explicit approval.
|