skills/conorbronsdon__avoid-ai-writing
1
0
Fork 0
mirror of https://github.com/conorbronsdon/avoid-ai-writing.git synced 2026-09-19 01:32:11 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: refresh repository guidance (#106)

Browse Source
This commit is contained in:
Jason Colapietro
2026-08-04 03:05:04 -04:00
committed by GitHub
parent f9fef0ee35
commit cf60f76757
2 changed files with 7 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.ssot.yaml
+2
View File
@@ -35,6 +35,8 @@ facts:
file: README.md
pattern: '\*\*(\d+) pattern categories\*\*'
copies:
- file: CLAUDE.md
pattern: 'README "(\d+) pattern categories" bullet'
- file: ../agent-skills/README.md
pattern: '(\d+) pattern categories'
- file: ../ai-tools-for-creators/README.md
CLAUDE.md
+5 -4
View File
@@ -4,23 +4,24 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
## What this is
A single-file writing skill (`SKILL.md`) that audits and rewrites content to remove AI writing patterns. No build system, no dependencies, no tests — the skill is a markdown file consumed by AI coding assistants.
A single-file writing skill (`SKILL.md`) that audits and rewrites content to remove AI writing patterns. The skill is a markdown file consumed by AI coding assistants; the repository also includes a dependency-free deterministic detector and test suite.
## Repository structure
- `SKILL.md` — the skill itself (v3.7.2). This is the product. All rules, tiers, profiles, and output format live here.
- `SKILL.md` — the skill itself. This is the product. All rules, tiers, profiles, and output format live here.
- `README.md` — public-facing docs, installation instructions, pattern reference table, full before/after example.
- `CHANGELOG.md` — version history with what changed and why.
## How to make changes
Edit `SKILL.md` directly. There's nothing to build or test. When making changes:
Edit `SKILL.md` directly. When making changes:
- Bump the version in the SKILL.md frontmatter (`version: X.Y.Z`)
- Run `bash scripts/sync-plugin-skill.sh`. Root SKILL.md is the source of truth; the plugin's bundled copy and `plugin.json`'s version are generated from it, and CI fails on a mismatch. Bumping the frontmatter without this step fails the `check` job with `version mismatch: SKILL.md=X plugin.json=Y`.
- Run `npm test` to exercise the detector, category contract, validator, corpus helpers, and style checks.
- Add a dated entry to CHANGELOG.md
- Update README.md if the change affects installation, usage, feature list, or pattern count
- The pattern count lives in **one** place — the README "46 pattern categories" bullet — and is derived from SKILL.md's detection `###` entries. Don't restate it elsewhere; CI (`scripts/check-pattern-count.sh`) fails the build if the README number drifts from SKILL.md, so just add the new `###` entry and bump the README bullet.
- The pattern count lives in **one** place — the README "61 pattern categories" bullet — and is derived from SKILL.md's detection `###` entries. Don't restate it elsewhere; CI (`scripts/check-pattern-count.sh`) fails the build if the README number drifts from SKILL.md, so just add the new `###` entry and bump the README bullet.
## Architecture of the skill