changelog-updates
installsforks
How to install changelog-updates?
jonathimer/devmarketing-skills/changelog-updates
$npx -y skills add jonathimer/devmarketing-skills --skill changelog-updatesCreate release notes and product updates that developers actually read and care about. This skill covers changelog formatting, versioning communication, breaking change announcements, deprecation notices, and building anticipation for new features. Trigger phrases: "changelog", "
SKILL.md
| 1 | # Changelogs and Product Updates Developers Care About |
| 2 | |
| 3 | Release notes are developer communication, not documentation. When done well, they build trust, demonstrate momentum, and turn updates into marketing moments. |
| 4 | |
| 5 | ## Overview |
| 6 | |
| 7 | Changelogs serve multiple audiences and purposes: |
| 8 | - **Active developers**: "What changed that affects my integration?" |
| 9 | - **Evaluating developers**: "Is this product actively maintained?" |
| 10 | - **Developer advocates**: "What's worth sharing with my audience?" |
| 11 | - **Your team**: Historical record of what shipped and when |
| 12 | |
| 13 | This skill covers creating changelogs that inform, build trust, and occasionally delight. |
| 14 | |
| 15 | ## Before You Start |
| 16 | |
| 17 | Review the **developer-audience-context** skill to understand: |
| 18 | - How do your developers prefer to receive updates? |
| 19 | - What changes do they care most about? |
| 20 | - How much detail do they need? |
| 21 | - What's their tolerance for breaking changes? |
| 22 | |
| 23 | Your changelog tone and detail level should match your audience. |
| 24 | |
| 25 | ## Changelog Format |
| 26 | |
| 27 | ### The Standard Structure |
| 28 | |
| 29 | ```markdown |
| 30 | # Changelog |
| 31 | |
| 32 | All notable changes to this project will be documented in this file. |
| 33 | |
| 34 | The format is based on [Keep a Changelog](https://keepachangelog.com/), |
| 35 | and this project adheres to [Semantic Versioning](https://semver.org/). |
| 36 | |
| 37 | ## [Unreleased] |
| 38 | ### Added |
| 39 | - New feature in development |
| 40 | |
| 41 | ## [2.3.0] - 2024-01-15 |
| 42 | ### Added |
| 43 | - New `analyze()` method for sentiment analysis |
| 44 | - Support for batch processing up to 100 items |
| 45 | |
| 46 | ### Changed |
| 47 | - Improved error messages with troubleshooting links |
| 48 | - Default timeout increased from 30s to 60s |
| 49 | |
| 50 | ### Deprecated |
| 51 | - `old_analyze()` will be removed in v3.0.0 |
| 52 | |
| 53 | ### Fixed |
| 54 | - Race condition in concurrent requests (#234) |
| 55 | - Memory leak when processing large files (#256) |
| 56 | |
| 57 | ## [2.2.1] - 2024-01-08 |
| 58 | ### Fixed |
| 59 | - Critical security patch for authentication bypass |
| 60 | |
| 61 | ## [2.2.0] - 2024-01-01 |
| 62 | ... |
| 63 | ``` |
| 64 | |
| 65 | ### Change Categories |
| 66 | |
| 67 | | Category | Use For | |
| 68 | |----------|---------| |
| 69 | | **Added** | New features, new endpoints, new parameters | |
| 70 | | **Changed** | Behavior changes, performance improvements | |
| 71 | | **Deprecated** | Features being phased out (still working) | |
| 72 | | **Removed** | Features that no longer exist | |
| 73 | | **Fixed** | Bug fixes | |
| 74 | | **Security** | Security-related changes | |
| 75 | |
| 76 | ### Good vs. Bad Entries |
| 77 | |
| 78 | **Good Changelog Entries:** |
| 79 | ```markdown |
| 80 | ### Added |
| 81 | - New `batch_analyze()` method processes up to 100 items in a single |
| 82 | request, reducing API calls by 90% for bulk operations. |
| 83 | [See docs](link) (#198) |
| 84 | |
| 85 | ### Fixed |
| 86 | - Fixed timeout errors when processing files larger than 10MB. |
| 87 | Uploads now stream in chunks, eliminating memory issues. (#234) |
| 88 | |
| 89 | ### Deprecated |
| 90 | - `legacy_auth()` will be removed in v3.0.0 (scheduled for March 2024). |
| 91 | Migrate to `oauth_auth()` using our [migration guide](link). |
| 92 | ``` |
| 93 | |
| 94 | **Bad Changelog Entries:** |
| 95 | ```markdown |
| 96 | ### Added |
| 97 | - New feature |
| 98 | |
| 99 | ### Fixed |
| 100 | - Fixed bug |
| 101 | - Fixed another bug |
| 102 | - Various improvements |
| 103 | |
| 104 | ### Changed |
| 105 | - Updated dependencies |
| 106 | ``` |
| 107 | |
| 108 | ### Writing Style |
| 109 | |
| 110 | **Be specific:** |
| 111 | ``` |
| 112 | ❌ "Improved performance" |
| 113 | ✅ "Reduced API response time by 40% for list operations" |
| 114 | ``` |
| 115 | |
| 116 | **Include context:** |
| 117 | ``` |
| 118 | ❌ "Fixed issue #234" |
| 119 | ✅ "Fixed timeout errors when uploading large files (#234)" |
| 120 | ``` |
| 121 | |
| 122 | **Link to resources:** |
| 123 | ``` |
| 124 | ✅ "New batch API - [documentation](link) | [migration guide](link)" |
| 125 | ``` |
| 126 | |
| 127 | **Explain impact:** |
| 128 | ``` |
| 129 | ✅ "Breaking: `user_id` parameter renamed to `id`. |
| 130 | Update your code before upgrading." |
| 131 | ``` |
| 132 | |
| 133 | ## What to Include |
| 134 | |
| 135 | ### Always Include |
| 136 | |
| 137 | **API Changes:** |
| 138 | - New endpoints |
| 139 | - New parameters |
| 140 | - Changed response formats |
| 141 | - Changed error codes |
| 142 | |
| 143 | **SDK Changes:** |
| 144 | - New methods |
| 145 | - Changed method signatures |
| 146 | - New configuration options |
| 147 | |
| 148 | **Breaking Changes:** |
| 149 | - Anything that requires code changes |
| 150 | - Removed features |
| 151 | - Changed defaults |
| 152 | |
| 153 | **Security Fixes:** |
| 154 | - Even if vague, acknowledge security updates |
| 155 | - Follow responsible disclosure timeline |
| 156 | |
| 157 | ### Consider Including |
| 158 | |
| 159 | **Performance Improvements:** |
| 160 | ```markdown |
| 161 | ### Changed |
| 162 | - List operations now 3x faster through pagination optimization |
| 163 | ``` |
| 164 | |
| 165 | **Developer Experience:** |
| 166 | ```markdown |
| 167 | ### Added |
| 168 | - Error messages now include troubleshooting links |
| 169 | - SDK now validates API keys at initialization |
| 170 | ``` |
| 171 | |
| 172 | **Infrastructure:** |
| 173 | ```markdown |
| 174 | ### Changed |
| 175 | - New data center in EU (eu-west.api.example.com) |
| 176 | - Increased rate limits from 100 to 500 requests/minute |
| 177 | ``` |
| 178 | |
| 179 | ### Skip or Minimize |
| 180 | |
| 181 | **Internal refactoring:** |
| 182 | ```markdown |
| 183 | ❌ "Refactored authentication module" |
| 184 | (unless it affects developers) |
| 185 | ``` |
| 186 | |
| 187 | **Minor dependency updates:** |
| 188 | ```markdown |
| 189 | ❌ "Updated lodash f |
People who liked this also viewed
6 picksType
- find-skillsHelps users discover and install agent skills when they ask questions like "how do I do X", "find a skill for X", "is there a skill that can...", or express interest in extending capabilities. This skSkillsJul 2026
- grill-meA relentless interview to sharpen a plan or design.SkillsJul 2026
- vercel-react-best-practicesVercel's official collection of agent skillsSkillsJul 2026
- improve-codebase-architectureScan a codebase for deepening opportunities, present them as a visual HTML report, then grill through whichever one you pick.SkillsJul 2026
- setup-matt-pocock-skillsConfigure this repo for the engineering skills — set up its issue tracker, triage label vocabulary, and domain doc layout. Run once before first use of the other engineering skills.SkillsJul 2026
- triageMove issues and external PRs through a state machine of triage roles — categorise, verify, grill if needed, and write agent-ready briefs.SkillsJul 2026
