Skip to content

Commit 1b857a9

Browse files
committed
claude.md: defer release notes style to global config
The full WooCommerce-style format spec now lives in ~/.claude/CLAUDE.md so it applies to every plugin and theme, not just Jetonomy. Plugin-level CLAUDE.md keeps a short pointer plus the reference-implementation note.
1 parent 6f7986c commit 1b857a9

1 file changed

Lines changed: 2 additions & 33 deletions

File tree

CLAUDE.md

Lines changed: 2 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -52,40 +52,9 @@ Two further rules apply to every release:
5252
- **readme.txt is customer-facing**, not developer notes. Lead with what's new and what's fixed, in plain English. Internal commits/refactors stay in git history and PR descriptions.
5353
- **Release zip is verified by the build, not by hand.** `bin/build-release.sh` runs `grunt build` (Step 0), asserts every CSS/JS source has a `.min` pair (Step 5b), and rejects any top-level dev cruft (Step 5c). Manual extract-and-eyeball is the wrong model.
5454

55-
## Release Notes Style (readme.txt + GitHub releases)
55+
## Release Notes Style
5656

57-
Every changelog entry and GitHub release body must follow the WooCommerce-style action-prefix format. The same rules apply to both surfaces (readme.txt changelog AND GitHub release body):
58-
59-
### Format
60-
61-
```
62-
= 1.4.2 - May 2026 =
63-
64-
One-line summary of the release in plain English. No marketing fluff.
65-
66-
* New - Description of the new feature.
67-
* New - Description of another new feature.
68-
* Improve - Description of the improvement.
69-
* Fix - Description of the fix.
70-
* Security - Description of the security fix.
71-
* Dev - Developer-facing change (REST endpoint, hook, helper, CI).
72-
* Compat - Compatibility / lockstep note.
73-
```
74-
75-
### Rules
76-
77-
1. **One bullet per change with an action prefix.** Action labels: `New`, `Improve`, `Fix`, `Security`, `Dev`, `Compat`. Pad to 8 characters before ` - ` so columns line up. No feature-themed subheadings (`**Public or private community**`, `**For people who run a space**`) - the action label IS the section.
78-
2. **No emoji anywhere.** Not in summary, not in bullets, not in headings. Trophies, ballot boxes, party poppers all out. Section labels do the work.
79-
3. **No em-dashes (`-`) anywhere.** Use a regular hyphen `-`. Em-dash reads as AI-generated and has been flagged multiple times by the team. Sweep before tagging.
80-
4. **Short summary paragraph (optional).** One line of plain English under the version heading explains what the release is about. Skip it if the bullets speak for themselves (small fix releases).
81-
5. **Release title is `Plugin X.Y.Z - one-line summary`.** No em-dash. Examples: `Jetonomy 1.4.2 - Show & Tell, Ideas roadmap, multisite, scale` / `Jetonomy Pro 1.4.2 - Webhooks back online, multisite Pro install`.
82-
6. **Lockstep cross-link.** Free release body links to Pro release tag; Pro release body links to free release tag. Both halves of a customer's install are findable from either page.
83-
7. **Order within a version.** Group by action label in this order: New, Improve, Fix, Security, Dev, Compat. Keeps the most customer-relevant bullets at the top.
84-
8. **One sentence per bullet.** If a change needs two sentences, the first is the headline, the second is the detail. No marketing copy, no internal references (ticket IDs, branch names, commit SHAs in the bullet text).
85-
86-
### Why this style
87-
88-
WooCommerce, EDD, GravityForms, ACF, and most major WP plugins use this format. It is the closest thing to a standard for WordPress.org readme.txt. Scannable, easy to translate, easy to share, easy to diff between versions. The rule lives here so we do not repeat the same cleanup on the next release.
57+
See **`~/.claude/CLAUDE.md` -> "Release Notes Style (ALL plugins & themes)"** for the canonical format spec. Same WooCommerce-style action-prefix rules apply to this plugin's `readme.txt` and GitHub release body. This plugin is the reference implementation — open `readme.txt` for the exact pattern.
8958

9059
## Quick Reference
9160
- **Type**: WordPress Plugin (forum, Q&A, ideas, social feed)

0 commit comments

Comments
 (0)