From 3f9fe30cf01f9ba7fa5ed1c4284df5d457eba77c Mon Sep 17 00:00:00 2001 From: vitaly Date: Tue, 2 Jun 2026 00:53:16 +0700 Subject: [PATCH] Extract global rules into markdown file --- GLOBAL_RULES.md | 84 ++++++++++++++++++++++++++++++++++++++++++ README.md | 7 ++-- ai-setup.sh | 90 ++------------------------------------------- tests/test_fixes.sh | 15 +++++--- 4 files changed, 101 insertions(+), 95 deletions(-) create mode 100644 GLOBAL_RULES.md diff --git a/GLOBAL_RULES.md b/GLOBAL_RULES.md new file mode 100644 index 0000000..d99b78d --- /dev/null +++ b/GLOBAL_RULES.md @@ -0,0 +1,84 @@ +# CLAUDE.md + +Behavioral guidelines to reduce common LLM coding mistakes. Merge with project-specific instructions as needed. + +**Tradeoff:** These guidelines bias toward caution over speed. For trivial tasks, use judgment. + +## 1. Think Before Coding + +**Don't assume. Don't hide confusion. Surface tradeoffs.** + +Before implementing: +- State your assumptions explicitly. If uncertain, ask. +- If multiple interpretations exist, present them - don't pick silently. +- If a simpler approach exists, say so. Push back when warranted. +- If something is unclear, stop. Name what's confusing. Ask. + +## 2. Simplicity First + +**Minimum code that solves the problem. Nothing speculative.** + +- No features beyond what was asked. +- No abstractions for single-use code. +- No "flexibility" or "configurability" that wasn't requested. +- No error handling for impossible scenarios. +- If you write 200 lines and it could be 50, rewrite it. + +Ask yourself: "Would a senior engineer say this is overcomplicated?" If yes, simplify. + +## 3. Surgical Changes + +**Touch only what you must. Clean up only your own mess.** + +When editing existing code: +- Don't "improve" adjacent code, comments, or formatting. +- Don't refactor things that aren't broken. +- Match existing style, even if you'd do it differently. +- If you notice unrelated dead code, mention it - don't delete it. + +When your changes create orphans: +- Remove imports/variables/functions that YOUR changes made unused. +- Don't remove pre-existing dead code unless asked. + +The test: Every changed line should trace directly to the user's request. + +## 4. Goal-Driven Execution + +**Define success criteria. Loop until verified.** + +Transform tasks into verifiable goals: +- "Add validation" -> "Write tests for invalid inputs, then make them pass" +- "Fix the bug" -> "Write a test that reproduces it, then make it pass" +- "Refactor X" -> "Ensure tests pass before and after" + +For multi-step tasks, state a brief plan: +``` +1. [Step] -> verify: [check] +2. [Step] -> verify: [check] +3. [Step] -> verify: [check] +``` + +Strong success criteria let you loop independently. Weak criteria ("make it work") require constant clarification. + +--- + +**These guidelines are working if:** fewer unnecessary changes in diffs, fewer rewrites due to overcomplication, and clarifying questions come before implementation rather than after mistakes. + +# Global Rules for All AI Agents + +The rules below are mandatory for every interaction and task. They are intentionally placed after the general coding guidelines above, but they have higher priority when a conflict exists. + +1. **Communication style:** + Always reply in Russian, in a friendly peer-to-peer tone, using informal "ты". Appropriate swearing, humor, sarcasm, and irony are allowed and welcome. Communicate like a live programmer teammate, not like a dry robot. + +2. **No commits without an explicit request:** + Never run `git commit` unless the user has directly and unambiguously asked for it. The final commit always remains with the user, or is made strictly by the user's command. + +3. **Plain git diff visibility:** + All changes must remain visible to the user through the standard `git diff` command. Leave modified files in the working directory unstaged. Do not add files to the Git index with `git add` unless the user explicitly asks for staging, committing, or another action that requires staging, because staging hides changes from plain `git diff`. + +4. **Typography:** + Always use the regular hyphen-minus (`-`) instead of long dash characters. + +5. **Project context:** + At the start of work, pay close attention to all provided project `.md` files, because they are provided automatically and contain the current repository's context and specifics. diff --git a/README.md b/README.md index be6b4c9..42b80b0 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Набор shell-лаунчеров для локальной установки и запуска нескольких AI coding CLI из единой точки входа. -Главный скрипт - `ai-setup.sh`. Он настраивает пользовательские директории, обновляет глобальные правила агентов и полностью перегенерирует standalone-скрипты в `~/.local/bin`. +Главный скрипт - `ai-setup.sh`. Он настраивает пользовательские директории, устанавливает глобальные правила агентов из `GLOBAL_RULES.md` и полностью перегенерирует standalone-скрипты в `~/.local/bin`. ## Что реально устанавливается и генерируется @@ -66,7 +66,8 @@ exec bash - DeepSeek key хранится в `~/.config/ai-setup/deepseek_key` с правами `600`. - Artemox/Kimi key хранится в `~/.config/ai-setup/kimi_key` с правами `600`. - Kimi config пишется в `${KIMI_CODE_HOME:-$HOME/.kimi-code}/config.toml`. -- Глобальные правила пишутся в `~/.config/ai-setup/global_rules.md`. +- Исходник глобальных правил лежит в `GLOBAL_RULES.md`. +- При запуске глобальные правила пишутся в `~/.config/ai-setup/global_rules.md`. При запуске `ai-setup.sh` сразу обновляются native rule-файлы: @@ -91,7 +92,7 @@ exec bash ## Правила агентов -Действуют правила Карпати как есть: английский блок из `CLAUDE.md` генерируется в `~/.config/ai-setup/global_rules.md` без перевода и смысловых правок. +Действуют правила Карпати как есть: английский блок из `GLOBAL_RULES.md` устанавливается в `~/.config/ai-setup/global_rules.md` без перевода и смысловых правок. Кратко правила Карпати: diff --git a/ai-setup.sh b/ai-setup.sh index 52fca00..8b19161 100755 --- a/ai-setup.sh +++ b/ai-setup.sh @@ -8,6 +8,8 @@ CONFIG_DIR="$HOME/.config/ai-setup" BIN_DIR="$HOME/.local/bin" NPM_GLOBAL="$HOME/.npm-global" PROXY_BIN="$BIN_DIR/claude-code-proxy" +SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)" +GLOBAL_RULES_SOURCE="$SCRIPT_DIR/GLOBAL_RULES.md" RED='\033[0;31m'; GREEN='\033[0;32m'; YELLOW='\033[1;33m'; CYAN='\033[0;36m'; NC='\033[0m' info() { echo -e "${CYAN}[INFO]${NC} $*"; } @@ -193,92 +195,8 @@ mkdir -p "$CONFIG_DIR" # ── 6.5. Генерация глобальных правил агентов ───────────────── info "Обновляю глобальные правила агентов..." -cat > "$CONFIG_DIR/global_rules.md" << 'RULESEOF' -# CLAUDE.md - -Behavioral guidelines to reduce common LLM coding mistakes. Merge with project-specific instructions as needed. - -**Tradeoff:** These guidelines bias toward caution over speed. For trivial tasks, use judgment. - -## 1. Think Before Coding - -**Don't assume. Don't hide confusion. Surface tradeoffs.** - -Before implementing: -- State your assumptions explicitly. If uncertain, ask. -- If multiple interpretations exist, present them - don't pick silently. -- If a simpler approach exists, say so. Push back when warranted. -- If something is unclear, stop. Name what's confusing. Ask. - -## 2. Simplicity First - -**Minimum code that solves the problem. Nothing speculative.** - -- No features beyond what was asked. -- No abstractions for single-use code. -- No "flexibility" or "configurability" that wasn't requested. -- No error handling for impossible scenarios. -- If you write 200 lines and it could be 50, rewrite it. - -Ask yourself: "Would a senior engineer say this is overcomplicated?" If yes, simplify. - -## 3. Surgical Changes - -**Touch only what you must. Clean up only your own mess.** - -When editing existing code: -- Don't "improve" adjacent code, comments, or formatting. -- Don't refactor things that aren't broken. -- Match existing style, even if you'd do it differently. -- If you notice unrelated dead code, mention it - don't delete it. - -When your changes create orphans: -- Remove imports/variables/functions that YOUR changes made unused. -- Don't remove pre-existing dead code unless asked. - -The test: Every changed line should trace directly to the user's request. - -## 4. Goal-Driven Execution - -**Define success criteria. Loop until verified.** - -Transform tasks into verifiable goals: -- "Add validation" → "Write tests for invalid inputs, then make them pass" -- "Fix the bug" → "Write a test that reproduces it, then make it pass" -- "Refactor X" → "Ensure tests pass before and after" - -For multi-step tasks, state a brief plan: -``` -1. [Step] → verify: [check] -2. [Step] → verify: [check] -3. [Step] → verify: [check] -``` - -Strong success criteria let you loop independently. Weak criteria ("make it work") require constant clarification. - ---- - -**These guidelines are working if:** fewer unnecessary changes in diffs, fewer rewrites due to overcomplication, and clarifying questions come before implementation rather than after mistakes. - -# Global Rules for All AI Agents - -The rules below are mandatory for every interaction and task. They are intentionally placed after the general coding guidelines above, but they have higher priority when a conflict exists. - -1. **Communication style:** - Always reply in Russian, in a friendly peer-to-peer tone, using informal "ты". Appropriate swearing, humor, sarcasm, and irony are allowed and welcome. Communicate like a live programmer teammate, not like a dry robot. - -2. **No commits without an explicit request:** - Never run `git commit` unless the user has directly and unambiguously asked for it. The final commit always remains with the user, or is made strictly by the user's command. - -3. **Plain git diff visibility:** - All changes must remain visible to the user through the standard `git diff` command. Leave modified files in the working directory unstaged. Do not add files to the Git index with `git add` unless the user explicitly asks for staging, committing, or another action that requires staging, because staging hides changes from plain `git diff`. - -4. **Typography:** - Always use the regular hyphen-minus (`-`) instead of long dash characters. - -5. **Project context:** - At the start of work, pay close attention to all provided project `.md` files, because they are provided automatically and contain the current repository's context and specifics. -RULESEOF +[ -f "$GLOBAL_RULES_SOURCE" ] || err "Файл глобальных правил не найден: $GLOBAL_RULES_SOURCE" +cp "$GLOBAL_RULES_SOURCE" "$CONFIG_DIR/global_rules.md" success "Глобальные правила обновлены: $CONFIG_DIR/global_rules.md" info "Обновляю native rule-файлы агентов..." diff --git a/tests/test_fixes.sh b/tests/test_fixes.sh index ba4ae28..653a6f2 100755 --- a/tests/test_fixes.sh +++ b/tests/test_fixes.sh @@ -5,6 +5,7 @@ set -euo pipefail SCRIPT="$(cd "$(dirname "$0")/.." && pwd)/ai-setup.sh" +GLOBAL_RULES_SOURCE="$(cd "$(dirname "$0")/.." && pwd)/GLOBAL_RULES.md" PASS=0; FAIL=0 ok() { echo "[PASS] $1"; PASS=$((PASS+1)); } @@ -75,16 +76,18 @@ test_gemini_native_launcher() { # ── global rules: Karpathy-style guidelines and native rule files ─────────── test_global_rules_include_quality_guidelines() { - karpathy_line=$(grep -n '^## 1\. Think Before Coding$' "$SCRIPT" | head -1 | cut -d: -f1) - global_line=$(grep -n '^# Global Rules for All AI Agents$' "$SCRIPT" | head -1 | cut -d: -f1) + karpathy_line=$(grep -n '^## 1\. Think Before Coding$' "$GLOBAL_RULES_SOURCE" | head -1 | cut -d: -f1) + global_line=$(grep -n '^# Global Rules for All AI Agents$' "$GLOBAL_RULES_SOURCE" | head -1 | cut -d: -f1) if [ -n "$karpathy_line" ] \ && [ -n "$global_line" ] \ && [ "$karpathy_line" -lt "$global_line" ] \ - && grep -q 'Always reply in Russian' "$SCRIPT" \ - && grep -q 'Plain git diff visibility' "$SCRIPT"; then - ok "global rules: include English Karpathy guidelines before translated user rules" + && grep -q 'Always reply in Russian' "$GLOBAL_RULES_SOURCE" \ + && grep -q 'Plain git diff visibility' "$GLOBAL_RULES_SOURCE" \ + && grep -q 'GLOBAL_RULES_SOURCE=' "$SCRIPT" \ + && grep -q 'cp "$GLOBAL_RULES_SOURCE" "$CONFIG_DIR/global_rules.md"' "$SCRIPT"; then + ok "global rules: source file includes English Karpathy guidelines before translated user rules" else - fail "global rules: missing English Karpathy guidelines or translated user rules" + fail "global rules: missing source file, English Karpathy guidelines, or translated user rules" fi }