Skip to content

WARP.md

Latest commit

 

History

History
57 lines (43 loc) · 2.52 KB

WARP.md

File metadata and controls

57 lines (43 loc) · 2.52 KB
Raw

WARP.md

This file provides guidance to WARP (warp.dev) when working with code in this repository.

What this repo is

This repository is a Claude Code / OpenCode skill implemented entirely as Markdown.

The “runtime” artifact is SKILL.md: Claude Code reads the YAML frontmatter (metadata + allowed tools) and the prompt/instructions that follow.

README.md is for humans: installation, usage, a compact overview of the language modules, and research references.

Key files (and how they relate)

  • SKILL.md
    • The actual skill definition.
    • Starts with YAML frontmatter (--- … ---) containing name, version, description, and allowed-tools.
    • After the frontmatter is the editor prompt: the canonical, detailed pattern list with examples.
  • README.md
    • Installation and usage instructions.
    • Contains a summarized overview of the English and Russian modules and a short version history.

When changing behavior/content, treat SKILL.md as the source of truth, and update README.md to stay consistent.

The skill is bilingual. Keep English and Russian rules separated. Do not move shared-looking patterns into a generic "universal" pattern list, because the agent must choose only the module that matches the input language.

Common commands

Install the skill into Claude Code

Recommended (clone directly into Claude Code skills directory):

mkdir -p ~/.claude/skills
git clone https://github.com/timsmykov/humanizer.git ~/.claude/skills/humanizer

Manual install/update (only the skill file):

mkdir -p ~/.claude/skills/humanizer
cp SKILL.md ~/.claude/skills/humanizer/

How to “run” it (Claude Code)

Invoke the skill:

  • /humanizer then paste text

Making changes safely

Versioning (keep in sync)

  • SKILL.md has a version: field in its YAML frontmatter.
  • README.md has a “Version history” section.

If you bump the version, update both.

Editing SKILL.md

  • Preserve valid YAML frontmatter formatting and indentation.
  • Keep English and Russian modules independent.
  • Prefer language-prefixed pattern IDs (EN-*, RU-*) over one global numbering sequence.
  • Do not apply English punctuation or style rules directly to Russian. Russian has different norms for dashes, quotes, bureaucratic register, and legal/scientific definitions.

Documenting non-obvious fixes

If you change the prompt to handle a tricky failure mode (e.g., a repeated mis-edit or an unexpected tone shift), add a short note to README.md’s version history describing what was fixed and why.