mailpoet/writing-changelog
.ai/skills/writing-changelog/SKILL.md
Use when adding a changelog entry for a branch. Use after completing work on a feature, fix, or improvement that is user-facing.
$ install --global
skillsauthnpx skillsauth add mailpoet/mailpoet writing-changelogInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
Security Scan Results
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
3
Scanners Passed
9
Scanners in report
Clean
TrivyContainer and dependency vulnerability scanner
95%
Clean
SemgrepStatic code analysis for vulnerabilities
95%
Clean
mcp-scan (Snyk)Model Context Protocol security validation
95%
Skipped
Snyk (dep)Open source security scanning
50%
Skipped
Socket.devSupply chain security analysis
50%
Skipped
VirusTotalMulti-engine malware detection
50%
Skipped
CrowdStrikeAdvanced threat intelligence
50%
Skipped
OSV-ScannerOpen Source Vulnerability database check
50%
Skipped
OWASP Dep-Check
50%
Last scanned: Apr 6, 2026, 10:09 PM20.5s1 file scanned
SKILL.md
- name:
- writing-changelog
- description:
- Use when adding a changelog entry for a branch. Use after completing work on a feature, fix, or improvement that is user-facing.
Writing Changelog Entries
Overview
User-facing changes MUST have a changelog entry. Each entry is a small Markdown file created by the ./do changelog:add command. Follow the steps below in order.
Workflow
Step 1: Analyze Branch Changes
Compare the current branch against the base branch to understand what changed.
Read the relevant code changes to understand the user-facing impact.
Step 2: Categorize and Describe
Pick one valid type that best describes the change: Added, Improved, Fixed, Changed, Updated, Removed
Write a short, user-facing description:
- Write from the user's perspective — what they see or experience
- Avoid technical jargon (no class names, method names, internal details)
- Start with a verb or noun, not "We" or "The plugin"
- No trailing punctuation — the build system adds it
- Keep it to one sentence
Good examples:
Fix email rendering issue in OutlookAdd ability to filter subscribers by purchase dateImprove performance of subscriber listing page
Bad examples:
Refactor SubscriberRepository query method(technical jargon)Fix bug in NewsletterEntity::getStatus()(class/method names)Update dependencies.(trailing punctuation)
Step 3: Create the Entry
Run the command from the correct plugin directory:
- Free plugin changes → run from
mailpoet/ - Premium plugin changes → run from
mailpoet-premium/
cd mailpoet && ./do changelog:add --type=<type> --description="<description>"
When to Skip
Most branches need a changelog. Skip only when changes are:
- Test-only changes
- CI/build configuration changes
- Documentation-only changes
When in doubt, add a changelog entry.
Related Skills
mailpoet/writing-tests
development
VerifiedTrustedCommunity
Use when writing, running, or debugging tests. Use when asked to add test coverage, fix a failing test, or run a test suite.
154SKILL.mdUpdated Apr 6, 2026
mailpoet/starting-branch
testing
VerifiedTrustedCommunity
ALWAYS use when creating a new branch, starting work on a task, or working on a Linear issue. Handles branch naming, Linear lookup, and branch creation. Do NOT run git switch -c or git checkout -b directly.
154SKILL.mdUpdated Apr 6, 2026
mailpoet/reviewing-code
development
VerifiedTrustedCommunity
Use when reviewing pull requests or local code changes. Use when asked to review a PR, review code, test changes, verify implementation quality, or do a code review.
154SKILL.mdUpdated Apr 6, 2026
mailpoet/mailpoet-dev-cycle
development
VerifiedTrustedCommunity
Linting and code quality workflows for MailPoet development (PHP, JS/TS, CSS/SCSS). Use when fixing code style or following the development workflow.
154SKILL.mdUpdated Apr 6, 2026