# Working in this repository

> Rules, checks and pull request format for AI coding agents that change Trina AX.

This page is for AI coding agents, such as Claude Code or Codex, working in the Trina AX repository. The same rules apply to people.

> **Note:** The short version lives in [`CLAUDE.md`](https://github.com/trina-app/trina-ax/blob/main/CLAUDE.md) and [`AGENTS.md`](https://github.com/trina-app/trina-ax/blob/main/AGENTS.md) at the repository root. Read them first.

## Ground rules

- The product id in code is `mycel`: folders, sockets and `MYCEL_*` variables. Trina branding is in `editions/trina/branding/`.
- Read the [repository rules (Korean)](https://github.com/trina-app/trina-ax/blob/main/docs/REPOSITORY-RULES.md) before adding a feature. Shared features belong in the core first. [Read about core and Trina](/docs/develop/core-and-trina.md).
- Check [`docs/DECISIONS.md`](https://github.com/trina-app/trina-ax/blob/main/docs/DECISIONS.md) before changing permissions, engines or security behaviour.
- Licence: AGPL-3.0-only, except `shared/src/cloud-protocol/` (MIT). Keep LICENSE, NOTICE and dependency notices.

## Never commit

| Never | Instead |
|---|---|
| Secrets, keys, tokens, cookies, setup or invite links | Fictional placeholders |
| Customer data, real names, real addresses or host names | Fictional data, such as the demo team |
| Personal paths such as `/Users/<name>/` | Paths relative to the repository |
| A changed `bun.lock` you did not mean to change | `bun install --frozen-lockfile` |

## Checks to run

1. **Always**

   ```sh
   bun run typecheck
   ```

2. **For your change**

   | Changed | Run |
   |---|---|
   | Server | `bun run test:unit` or the related `tests/unit/` files |
   | Web | `bun run test:web`, `bun run build:web` and related e2e specs |
   | Strings | `bun run check:i18n` |
   | Docs | `bun run check:docs` |

3. **Compare failures**

   If a test fails, run it on an untouched checkout before blaming your change. Some suites need native helpers or document converters.

## Pull request format

- Branch from current `main`. Keep one focused change per pull request.
- A new feature starts with `넣을 곳: <repository/folder>, 이유: <one sentence>`.
- Fill in the pull request template: problem, change, validation and **Version impact** (`patch`, `minor`, `major` or `none`, with one reason). [Read how to choose](/docs/develop/versioning.md).
- Add screenshots with fictional data for visible UI changes.
- Update `CHANGELOG.md` for user-visible changes, and `docs/UPSTREAM.md` when you bring a change from the core.

## Actions that need a human

Do not, without explicit approval: force-push, rewrite history, push or merge to `main` directly, tag a release, change repository names or visibility, or connect to customer servers.

## Writing style for app strings and docs

Short sentences, plain words, the same word for the same thing, in all five languages. [Read the design rules](/docs/develop/i18n-and-design.md).