Skip to content

Commit 44e5ef7

Browse files
authored
Update agent guidelines (#338)
2 parents 370dab3 + 66274eb commit 44e5ef7

File tree

1 file changed

+42
-0
lines changed

1 file changed

+42
-0
lines changed

AGENTS.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Coding agent guidelines for public-ui.github.io
2+
3+
This repository contains the Docusaurus documentation for the KoliBri component library.
4+
5+
## Development setup
6+
7+
- Use **pnpm** as the package manager. Run `pnpm install` if dependencies are missing.
8+
- Check TypeScript and ESLint rules with `pnpm run lint`.
9+
- Ensure the site can be built locally with `pnpm run build`.
10+
11+
## Commit messages
12+
13+
Commits must follow the [Conventional Commits](https://www.conventionalcommits.org) style. A commitlint configuration is present in `commitlint.config.js`.
14+
15+
## Documentation and translation rules
16+
17+
Follow these rules when editing or adding docs:
18+
19+
- File names must be in **English** to generate SEO-friendly URLs.
20+
- Keep translations close to the original text.
21+
- Translation keys are written in English using **kebab-case**.
22+
- The default translation text (`message`) is written in **German**.
23+
- Use the `translate` method rather than the `Translate` component.
24+
- Do not add custom translation descriptions.
25+
- Avoid explicit `slug` definitions (except in `docs/welcome.md`); slugs are generated from file names.
26+
- All code samples and technical terms are in English.
27+
- Remove tag sections: replace `/tags:(\n.+)+/` with `---`.
28+
29+
## Formatting conventions
30+
31+
- Tabs are used for indentation except in Markdown files (see `.editorconfig`).
32+
- Prettier is configured for a line width of 120 characters and single quotes.
33+
34+
## Required checks before committing
35+
36+
Run the following commands and ensure they succeed:
37+
38+
```bash
39+
pnpm run lint
40+
pnpm run build
41+
```
42+

0 commit comments

Comments
 (0)