forked from blader/humanizer
-
Notifications
You must be signed in to change notification settings - Fork 0
docs: migrate WARP.md to Agents.md standard #1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
00a8ba8
docs: migrate WARP.md to Agents.md standard
57d9ced
style: fix markdown linting issues in documentation
8d241cb
fix: clean docs and sync adapter metadata
c553d0d
Merge branch 'main' into feat/migrate-agentsmd and resolve conflicts
bdc10bf
docs: address review comments, format JSON artifacts, and fix lint is…
ad8765c
Merge branch 'main' into feat/migrate-agentsmd and resolve quotation …
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,34 +1,81 @@ | ||
| --- | ||
| adapter_metadata: | ||
| skill_name: humanizer | ||
| skill_version: 2.1.1 | ||
| skill_version: 2.2.0 | ||
| last_synced: 2026-01-31 | ||
| source_path: SKILL.md | ||
| adapter_id: codex-cli | ||
| adapter_format: AGENTS.md | ||
| --- | ||
|
|
||
| # Humanizer (Codex CLI Adapter) | ||
| # Humanizer (Agents Manifest) | ||
coderabbitai[bot] marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| This file adapts the Humanizer skill for Codex CLI. The canonical rules live in `SKILL.md`. | ||
| Do not modify `SKILL.md` when updating this adapter. | ||
| This repository defines the **Humanizer** coding skill, designed to remove AI-generated patterns and improve prose quality. | ||
|
|
||
| ## Core Instructions | ||
| ## Capability | ||
|
|
||
| You are the Humanizer editor. | ||
| The Humanizer skill provides a set of 25 patterns for identifying and rewriting "AI-slop" or sterile writing. It preserves technical literals (code blocks, URLs, identifiers) while injecting personality and human-like voice. | ||
|
|
||
| Primary instructions: follow the canonical rules in SKILL.md. | ||
| - **Primary Prompt:** [SKILL.md](SKILL.md) | ||
| - **Supported Adapters:** See the `adapters/` directory for tool-specific implementations. | ||
|
|
||
| ## Context | ||
|
|
||
| This file serves as the **Agents.md** standard manifest for this repository. It provides guidance for AI agents (like yourself) to understand how to interact with this codebase. | ||
|
|
||
| ### Repository Structure | ||
|
|
||
| - `SKILL.md` | ||
| - The canonical source of truth for the skill definition. | ||
| - Contains YAML frontmatter for metadata and tools. | ||
| - Followed by the detailed pattern list and examples. | ||
| - `README.md` | ||
| - Human-focused installation and usage instructions. | ||
| - Contains the summarized "25 patterns" table. | ||
| - `adapters/` | ||
| - Tool-specific implementations (VS Code, Qwen, Copilot, Antigravity, etc.). | ||
| - `scripts/` | ||
| - Automation for syncing metadata from `SKILL.md` to all adapters. | ||
|
|
||
| ### Core Instructions (Codex CLI Adapter) | ||
|
|
||
| You are the Humanizer editor. Primary instructions: follow the canonical rules in `SKILL.md`. | ||
|
|
||
| When given text to humanize: | ||
|
|
||
| - Identify AI-writing patterns described in SKILL.md. | ||
| - Rewrite only the problematic sections while preserving meaning and tone. | ||
| - Identify AI-writing patterns described in `SKILL.md`. | ||
| - Rewrite only problematic sections while preserving meaning and tone. | ||
| - Preserve technical literals: inline code, fenced code blocks, URLs, file paths, identifiers. | ||
| - Preserve Markdown structure unless a local rewrite requires touching it. | ||
| - Output the rewritten text, then a short bullet summary of changes. | ||
|
|
||
| ## Usage | ||
| ## Guidelines | ||
|
|
||
| ### Making changes safely | ||
|
|
||
| #### Versioning | ||
|
|
||
| - `SKILL.md` has a `version:` field in its YAML frontmatter. | ||
| - `README.md` has a "Version History" section. | ||
| - **Rule:** If you bump the version, you must update both and run the sync scripts. | ||
|
|
||
| ### Editing SKILL.md | ||
|
|
||
| - Preserve valid YAML frontmatter formatting. | ||
| - Keep pattern numbering stable as it is referenced by all adapters. | ||
|
|
||
| ### Documenting fixes | ||
|
|
||
| - Add short notes to `README.md` version history for non-obvious fixes. | ||
|
|
||
| ## Interoperability | ||
|
|
||
| This repository is optimized for multi-agent use. If you are a specific tool, please check for your specialized adapter: | ||
|
|
||
| - **Antigravity:** `adapters/antigravity-skill/` or `adapters/antigravity-rules-workflows/` | ||
| - **VS Code:** `adapters/vscode/` | ||
| - **Gemini CLI:** `adapters/gemini-extension/` | ||
| - **Qwen CLI:** `adapters/qwen-cli/` | ||
| - **Copilot:** `adapters/copilot/` | ||
|
|
||
| - Invoke these instructions when the user asks to humanize text. | ||
| - If the user provides partial context, request the missing text. | ||
| - Prefer minimal edits that eliminate AI patterns without rewriting everything. | ||
| Run `scripts/sync-adapters.ps1` (PowerShell) or `scripts/sync_adapters.py` (Python) to propagate changes from the source of truth to these files. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.