Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[Русская версия](README.ru.md)

# Codex Workflow Skills

A portable workflow layer for using Codex on real software projects.
Expand All @@ -6,7 +8,7 @@ This repository is not an application framework. It provides:

- `AGENTS.md` — repository execution rules for Codex.
- `.agents/skills/` — reusable workflow skills for planning, implementation, frontend/design, validation, and platform work.
- `Use Cases.md` — copy-paste commands for invoking the skills effectively.
- [`Use Cases.md`](Use%20Cases.md) — copy-paste commands for invoking the skills effectively.
- `scripts/validate.sh` — local validation for skill metadata, bundled scripts, and repository hygiene.

## Why use it
Expand Down Expand Up @@ -62,7 +64,7 @@ Do not copy this repository `README.md` over a target project README. A target p

## Start using it

Open `Use Cases.md` and copy the command that matches the task.
Open [`Use Cases.md`](Use%20Cases.md) and copy the command that matches the task.

Examples:

Expand Down Expand Up @@ -135,7 +137,7 @@ The validator checks:
- each skill has `SKILL.md`;
- each skill frontmatter has only `name` and `description`;
- folder names match skill names;
- `Use Cases.md` references existing skills;
- [`Use Cases.md`](Use%20Cases.md) references existing skills;
- Python scripts compile;
- `.cjs` scripts pass `node --check` when Node is available;
- common junk, secrets, caches, old prompt folders, and generated artifacts are absent.
Expand All @@ -144,10 +146,10 @@ The GitHub Actions workflow runs the same validation on pushes and pull requests

## Contributing

See `CONTRIBUTING.md`.
See [`CONTRIBUTING.md`](CONTRIBUTING.md).

Keep changes practical: improve execution quality, reduce ambiguity, or add a broadly reusable workflow skill. Avoid decorative docs, duplicate rules, or one-off project assumptions.

## License

MIT. See `LICENSE`.
MIT. See [`LICENSE`](LICENSE).
36 changes: 36 additions & 0 deletions README.ru.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
[English version](README.md)

# Навыки Codex Workflow

Портативный workflow-слой для использования Codex в реальных программных проектах.

Этот репозиторий не является фреймворком приложения. Он предоставляет:

- [`AGENTS.md`](AGENTS.md) — правила выполнения задач для Codex.
- [`.agents/skills/`](.agents/skills/) — переиспользуемые workflow-навыки для планирования, реализации, frontend/design, валидации и platform-работ.
- [`Use Cases.ru.md`](Use%20Cases.ru.md) — готовые команды для запуска навыков.
- [`scripts/validate.sh`](scripts/validate.sh) — локальная проверка метаданных навыков, скриптов и гигиены репозитория.

## Зачем использовать

Используйте пакет, когда хотите, чтобы Codex работал по повторяемым стандартам выполнения вместо ad-hoc промптов.

## Как начать

Откройте [`Use Cases.ru.md`](Use%20Cases.ru.md) и скопируйте команду, соответствующую задаче.

## Проверка пакета

Запустите:

```bash
bash scripts/validate.sh
```

## Вклад

См. [`CONTRIBUTING.md`](CONTRIBUTING.md).

## Лицензия

MIT. См. [`LICENSE`](LICENSE).
Loading
Loading