skills.rest
mihai-dinculescu
mihai-dinculescuCOMMUNITY
Explore all skills by this author →
𝕏@faithravenGitHub

Changelog

Update CHANGELOG.md files following the Keep a Changelog format.

786|79|Updated Jun 6, 2022
Search Tags:#changelog#versioning#documentation#release notes#api changes
One-click install
npx skills add https://github.com/mihai-dinculescu/tapo --skill changelog-mihai-dinculescu
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: Changelog
Source: https://github.com/mihai-dinculescu/tapo/tree/main/.claude/skills/changelog
Command: npx skills add https://github.com/mihai-dinculescu/tapo --skill changelog-mihai-dinculescu

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill helps maintain a structured and consistent changelog for software projects, ensuring that changes are well-documented and easily understandable.

Core Features & Use Cases

  • Structured Updates: Follows the Keep a Changelog format for clear release notes.
  • Cross-Language Support: Accommodates changes affecting both Rust and Python libraries.
  • Use Case: When you release a new version of the Tapo API client, use this Skill to update the CHANGELOG.md file with a summary of new features, bug fixes, and breaking changes.

Quick Start

Update the changelog with the latest changes for the Rust library.

Frequently Asked Questions about Changelog

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I update a CHANGELOG.md file for Rust and Python libraries?▼

To update a CHANGELOG.md file, this Skill follows the Keep a Changelog format to document API modifications, categorizing additions, changes, fixes, and removals into separate sections for Rust and Python libraries.

What is the Keep a Changelog format for documenting API changes?▼

The Keep a Changelog format structures release notes into distinct categories like additions, changes, fixes, and removals, ensuring consistent documentation of API modifications for user discovery and understanding.

Can I maintain separate release notes sections for different programming languages?▼

Yes, you can maintain separate release notes sections, as this Skill explicitly supports distinct documentation blocks for Rust and Python libraries within the same project history.

How do I document breaking changes and new features in versioning?▼

You document breaking changes and new features by recording them under the fixed categories of additions, changes, fixes, and removals provided by the Keep a Changelog format structure.

Does this changelog generator work for the Tapo API client?▼

Yes, this changelog generator works for the Tapo API client, specifically summarizing new features, bug fixes, and breaking changes into the project's CHANGELOG.md file during version releases.

Related Skills

Explore More Software Engineering Skills→
k97k97
4

gen-release-notes

Generate structured release notes from git commit history and pull request data.

Community
Advanced
nickromneynickromney

Setup Semantic Release

Automate version bumps, changelog updates, and publishing from conventional commits.

Community
Advanced
jim60105jim60105
21

bump-version

Automate semantic version bumps, changelog generation, and Git tagging.

Community
Advanced
hicucuhicucu
1

weekly-commits

Aggregate git commit history into structured markdown reports by timeframe and author.

Community
Intermediate