-
Notifications
You must be signed in to change notification settings - Fork 0
feat: add clean writing skill #13
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
Open
j-d-ha
wants to merge
4
commits into
main
Choose a base branch
from
feat/add-writting-skill
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
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 @@ | ||
| ../../skills/clean-writing |
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 |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| --- | ||
| name: clean-writing | ||
| description: "Use for all user-facing prose: responses, drafts, edits, reviews, documentation, and technical explanations. Write clearly and naturally, without filler or lost nuance." | ||
| --- | ||
|
|
||
| # Clean writing | ||
|
|
||
| Write clearly, directly, and respectfully. Follow higher-priority and explicit user instructions. Do not add forced personality or imitation. | ||
|
|
||
| - Lead with the answer, decision, action, or point. Add context only when it helps readers understand or act. | ||
| - Preserve facts, uncertainty, and exact technical, legal, or evidentiary text. Do not invent specificity or turn uncertainty into certainty. | ||
| - Use plain words, concrete verbs, consistent terms, and active voice when the actor matters. Name relevant actors, reasons, limits, and failures. | ||
| - Match length and format to the task. Use structure only when it helps readers scan or act. Retain required syntax, labels, and formatting. | ||
|
|
||
| For technical explanations, state the result first, then add only material mechanism, evidence, or limits. Procedures need steps and expected results. Decisions need a recommendation, reason, and material cost or alternative. | ||
|
|
||
| For edits, return clean copy unless annotations or source formatting are requested. Preserve meaning and register, make the smallest useful change, and flag material ambiguity. | ||
|
|
||
| Cut greetings, praise, setup, boilerplate, hype, vague attribution, generic balance, repetition, decorative formatting, weak nominalizations, and stacked hedges. Keep contrasts, passive voice, and lists when helpful. |
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,49 @@ | ||
| { | ||
| "skill_name": "clean-writing", | ||
| "evals": [ | ||
| { | ||
| "id": 1, | ||
| "prompt": "The build failed because the database migration was not applied. Tell the user what happened and what to do next.", | ||
| "expected_output": "Leads with the failure and a concrete next action without greetings or filler.", | ||
| "files": [], | ||
| "expectations": [ | ||
| "States that the migration is missing.", | ||
| "Gives the command or action needed to apply it when available.", | ||
| "Preserves uncertainty if the cause is not confirmed." | ||
| ] | ||
| }, | ||
| { | ||
| "id": 2, | ||
| "prompt": "Explain why an HTTP cache can return stale data after an update.", | ||
| "expected_output": "Explains the mechanism and relevant limit in plain language.", | ||
| "files": [], | ||
| "expectations": [ | ||
| "States the explanation before background detail.", | ||
| "Explains that an older cached response may be served until invalidation or expiry.", | ||
| "Avoids unsupported claims about the application's cache settings." | ||
| ] | ||
| }, | ||
| { | ||
| "id": 3, | ||
| "prompt": "Rewrite this customer message: Great news! We are thrilled to announce that your report is now available. Let us know if you have any questions!", | ||
| "expected_output": "Returns a concise rewrite that keeps the message's meaning.", | ||
| "files": [], | ||
| "expectations": [ | ||
| "Removes the greeting, hype, and closing boilerplate.", | ||
| "Preserves the fact that the report is available.", | ||
| "Returns only the rewrite unless a note is needed." | ||
| ] | ||
| }, | ||
| { | ||
| "id": 4, | ||
| "prompt": "Review a pull request that removes a required authentication check. Start the finding with the repository's required blocking emoji.", | ||
| "expected_output": "Reports the security risk while preserving the required review format.", | ||
| "files": [], | ||
| "expectations": [ | ||
| "Keeps the required leading emoji.", | ||
| "Names the removed authentication check and concrete impact.", | ||
| "Suggests restoring the check." | ||
| ] | ||
| } | ||
| ] | ||
| } |
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,18 @@ | ||
| [ | ||
| { | ||
| "query": "Implement this API endpoint and tell me what changed.", | ||
| "should_trigger": true | ||
| }, | ||
| { | ||
| "query": "Review this pull request for bugs and explain the findings.", | ||
| "should_trigger": true | ||
| }, | ||
| { | ||
| "query": "Rewrite this update for customers.", | ||
| "should_trigger": true | ||
| }, | ||
| { | ||
| "query": "Use a tool to take a screenshot of the open browser tab.", | ||
| "should_trigger": true | ||
| } | ||
| ] |
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.
🔄 Unless the skill actually references the evals, consider moving outside of the skill folder. Otherwise, it will be deployed with the skill.
Uh oh!
There was an error while loading. Please reload this page.
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.
Not sure how I feel about this tbh. At first I totally agreed but after a quick search, I found this: https://agentskills.io/skill-creation/evaluating-skills.
TLDR: they say evals should be left inside the skill folder.
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.
Ok, I acquiesce...
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.
Although, I would expect to see some runs and benchmarks.