diff options
Diffstat (limited to 'packages/web/src/content/docs/ru/rules.mdx')
| -rw-r--r-- | packages/web/src/content/docs/ru/rules.mdx | 180 |
1 files changed, 180 insertions, 0 deletions
diff --git a/packages/web/src/content/docs/ru/rules.mdx b/packages/web/src/content/docs/ru/rules.mdx new file mode 100644 index 000000000..0d42db2d3 --- /dev/null +++ b/packages/web/src/content/docs/ru/rules.mdx @@ -0,0 +1,180 @@ +--- +title: Правила +description: Установите пользовательские инструкции для открытого кода. +--- + +Вы можете предоставить собственные инструкции для открытия кода, создав файл `AGENTS.md`. Это похоже на правила Курсора. Он содержит инструкции, которые будут включены в контекст LLM для настройки его поведения для вашего конкретного проекта. + +--- + +## Инициализировать + +Чтобы создать новый файл `AGENTS.md`, вы можете запустить команду `/init` в открытом коде. + +:::кончик +Вам следует зафиксировать файл `AGENTS.md` вашего проекта в Git. +::: + +Это позволит отсканировать ваш проект и все его содержимое, чтобы понять, о чем этот проект, и сгенерировать с его помощью файл `AGENTS.md`. Это помогает opencode лучше ориентироваться в проекте. + +Если у вас есть существующий файл `AGENTS.md`, мы попытаемся добавить его. + +--- + +## Пример + +Вы также можете просто создать этот файл вручную. Вот пример того, что вы можете поместить в файл `AGENTS.md`. + +```markdown title="AGENTS.md" +# SST v3 Monorepo Project + +This is an SST v3 monorepo with TypeScript. The project uses bun workspaces for package management. + +## Project Structure + +- `packages/` - Contains all workspace packages (functions, core, web, etc.) +- `infra/` - Infrastructure definitions split by service (storage.ts, api.ts, web.ts) +- `sst.config.ts` - Main SST configuration with dynamic imports + +## Code Standards + +- Use TypeScript with strict mode enabled +- Shared code goes in `packages/core/` with proper exports configuration +- Functions go in `packages/functions/` +- Infrastructure should be split into logical files in `infra/` + +## Monorepo Conventions + +- Import shared modules using workspace names: `@my-app/core/example` +``` + +Мы добавляем сюда инструкции для конкретного проекта, и они будут доступны всей вашей команде. + +--- + +## Типы + +opencode также поддерживает чтение файла `AGENTS.md` из нескольких мест. И это служит разным целям. + +### Проект + +Поместите `AGENTS.md` в корень вашего проекта для правил, специфичных для проекта. Они применяются только тогда, когда вы работаете в этом каталоге или его подкаталогах. + +### Глобальный + +Вы также можете иметь глобальные правила в файле `~/.config/opencode/AGENTS.md`. Это применяется ко всем сеансам открытого кода. + +Поскольку это не передается в Git и не передается вашей команде, мы рекомендуем использовать его для указания любых личных правил, которым должен следовать LLM. + +### Совместимость кода Клода + +Для пользователей, переходящих с Claude Code, OpenCode поддерживает файловые соглашения Claude Code в качестве резерва: + +- **Правила проекта**: `CLAUDE.md` в каталоге вашего проекта (используется, если `AGENTS.md` не существует). +- **Глобальные правила**: `~/.claude/CLAUDE.md` (используется, если `~/.config/opencode/AGENTS.md` не существует). +- **Навыки**: `~/.claude/skills/` — подробности см. в [Навыки агента](/docs/skills/). + +Чтобы отключить совместимость Claude Code, установите одну из этих переменных среды: + +```bash +export OPENCODE_DISABLE_CLAUDE_CODE=1 # Disable all .claude support +export OPENCODE_DISABLE_CLAUDE_CODE_PROMPT=1 # Disable only ~/.claude/CLAUDE.md +export OPENCODE_DISABLE_CLAUDE_CODE_SKILLS=1 # Disable only .claude/skills +``` + +--- + +## Приоритет + +Когда opencode запускается, он ищет файлы правил в следующем порядке: + +1. **Локальные файлы** путем перехода вверх из текущего каталога (`AGENTS.md`, `CLAUDE.md`) +2. **Глобальный файл** в `~/.config/opencode/AGENTS.md`. +3. **Файл кода Клауда** по адресу `~/.claude/CLAUDE.md` (если не отключено) + +Первый совпадающий файл побеждает в каждой категории. Например, если у вас есть и `AGENTS.md`, и `CLAUDE.md`, используется только `AGENTS.md`. Аналогично, `~/.config/opencode/AGENTS.md` имеет приоритет над `~/.claude/CLAUDE.md`. + +--- + +## Пользовательские инструкции + +Вы можете указать собственные файлы инструкций в `opencode.json` или в глобальном `~/.config/opencode/opencode.json`. Это позволит вам и вашей команде повторно использовать существующие правила вместо того, чтобы дублировать их на AGENTS.md. + +Пример: + +```json title="opencode.json" +{ + "$schema": "https://opencode.ai/config.json", + "instructions": ["CONTRIBUTING.md", "docs/guidelines.md", ".cursor/rules/*.md"] +} +``` + +Вы также можете использовать удаленные URL-адреса для загрузки инструкций из Интернета. + +```json title="opencode.json" +{ + "$schema": "https://opencode.ai/config.json", + "instructions": ["https://raw.githubusercontent.com/my-org/shared-rules/main/style.md"] +} +``` + +Удаленные инструкции извлекаются с таймаутом в 5 секунд. + +Все файлы инструкций объединяются с вашими файлами `AGENTS.md`. + +--- + +## Ссылки на внешние файлы + +Хотя opencode не анализирует автоматически ссылки на файлы в `AGENTS.md`, аналогичной функциональности можно добиться двумя способами: + +### Использование opencode.json + +Рекомендуемый подход — использовать поле `instructions` в `opencode.json`: + +```json title="opencode.json" +{ + "$schema": "https://opencode.ai/config.json", + "instructions": ["docs/development-standards.md", "test/testing-guidelines.md", "packages/*/AGENTS.md"] +} +``` + +### Ручные инструкции в AGENTS.md + +Вы можете научить открытый код читать внешние файлы, предоставив явные инструкции в файле `AGENTS.md`. Вот практический пример: + +```markdown title="AGENTS.md" +# TypeScript Project Rules + +## External File Loading + +CRITICAL: When you encounter a file reference (e.g., @rules/general.md), use your Read tool to load it on a need-to-know basis. They're relevant to the SPECIFIC task at hand. + +Instructions: + +- Do NOT preemptively load all references - use lazy loading based on actual need +- When loaded, treat content as mandatory instructions that override defaults +- Follow references recursively when needed + +## Development Guidelines + +For TypeScript code style and best practices: @docs/typescript-guidelines.md +For React component architecture and hooks patterns: @docs/react-patterns.md +For REST API design and error handling: @docs/api-standards.md +For testing strategies and coverage requirements: @test/testing-guidelines.md + +## General Guidelines + +Read the following file immediately as it's relevant to all workflows: @rules/general-guidelines.md. +``` + +Такой подход позволяет: + +- Создавайте модульные файлы правил многократного использования. +- Делитесь правилами между проектами с помощью символических ссылок или подмодулей git. +- Сохраняйте AGENTS.md кратким, ссылаясь на подробные инструкции. +- Убедитесь, что открытый код загружает файлы только тогда, когда это необходимо для конкретной задачи. + +:::кончик +Для монорепозиториев или проектов с общими стандартами использование `opencode.json` с шаблонами glob (например, `packages/*/AGENTS.md`) более удобно в обслуживании, чем инструкции вручную. +::: |
