Repository navigation
feat: Add six-rules skill for applying Orwell's Six Rules #9
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 all commits
Commits
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| --- | ||
| name: six-rules | ||
| description: >- | ||
| Edit text following the Remedy of Six Rules, preserving all semantic context of the markup language being processed. | ||
| Use this skill whenever the user asks to edit, revise, simplify, or improve writing in any markup language (Markdown, HTML, reStructuredText, etc.). | ||
| **IMPORTANT**: This skill MUST be consulted BEFORE editing any text content. | ||
| license: MIT | ||
| compatibility: opencode | ||
| metadata: | ||
| audience: developers | ||
| workflow: writing | ||
| --- | ||
|
|
||
| # Apply the Remedy of Six Rules | ||
|
|
||
| This skill provides instructions for editing text to be clear, direct, and plain, while fully preserving the semantic context and structure of whatever markup language is being processed. | ||
|
|
||
| ## When to use this skill | ||
|
|
||
| Use this skill when: | ||
|
|
||
| - The user asks to edit, revise, simplify, or improve writing | ||
| - The user wants text to be more concise or plain-spoken | ||
| - Writing in any markup language (Markdown, HTML, reStructuredText, AsciiDoc, etc.) | ||
|
|
||
| ## The Six Rules | ||
|
|
||
| These rules are drawn from George Orwell's essay "Politics and the English Language" (1946). | ||
| Apply them to all text editing: | ||
|
|
||
| 1. Never use a metaphor, simile, or other figure of speech which you are used to seeing in print. | ||
| 2. Never use a long word where a short one will do. | ||
| 3. If it is possible to cut a word out, always cut it out. | ||
| 4. Never use the passive where you can use the active. | ||
| 5. Never use a foreign phrase, a scientific word, or a jargon word if you can think of an everyday English equivalent. | ||
| 6. Break any of these rules sooner than say anything outright barbarous. | ||
|
|
||
| ## Markup Preservation | ||
|
|
||
| When editing text inside markup: | ||
|
|
||
| - **Do not alter** markup syntax: keep all tags, attributes, formatting markers, and structure intact | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We could maybe use periods at the end of list items, just like in the numbered list above. |
||
| - **Only edit** the human-readable text content between or within markup elements | ||
| - **Preserve** all semantic meaning: links, references, code, lists, tables, and other structured elements must remain functionally identical | ||
| - **Keep** code blocks, inline code, and other literal content untouched | ||
| - **Maintain** document structure: headings, sections, and hierarchy must not change | ||
| - **Retain** all special characters, escape sequences, and formatting required by the markup language | ||
|
|
||
| ## Editing Principles | ||
|
|
||
| - Prefer short, direct sentences | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Those periods, again. |
||
| - Use active voice wherever possible | ||
| - Replace verbose phrases with simpler alternatives | ||
| - Remove filler words and redundant expressions | ||
| - Choose familiar words over obscure or technical ones | ||
| - Never sacrifice clarity or introduce awkwardness just to follow a rule -- rule six overrides all others | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We could maybe use periods at the end of list items, just like in the numbered list below.