changelog-rules

Solid

Shared changelog conventions and formatting rules referenced by /create-changelog and /update-changelog. Not typically invoked directly.

Code & Development 335 stars 26 forks Updated 5 days ago MIT

Install

View on GitHub

Quality Score: 89/100

Stars 20%
84
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

# Changelog Rules The changelog is kept in `CHANGELOG.md` at the project root. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and projects using these conventions adhere to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## File Structure ```markdown # Changelog All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [Unreleased] ## [1.2.0] - 2024-03-15 ### Added - Add dark mode support ([#38](https://github.com/owner/repo/issues/38), [#42](https://github.com/owner/repo/pull/42)) ### Fixed - Fix crash on startup ([#40](https://github.com/owner/repo/issues/40), [#43](https://github.com/owner/repo/pull/43)) [Unreleased]: https://github.com/<owner>/<repo>/compare/v1.2.0...HEAD [1.2.0]: https://github.com/<owner>/<repo>/compare/v1.1.0...v1.2.0 [1.1.0]: https://github.com/<owner>/<repo>/releases/tag/v1.1.0 ``` ## Changelog-Worthiness Not every change belongs in a changelog. Changelogs are for humans, not machines. **Skip** changes that are purely internal: - Refactoring with no user-facing impact - Code formatting, linting, whitespace - Test additions or modifications (unless they indicate a fixed bug) - CI/CD configuration - Developer tooling (linters, editor config) - Documentation updates (README, comments, docstrings) - Dependency bum...

Details

Author
tobihagemann
Repository
tobihagemann/turbo
Created
3 months ago
Last Updated
5 days ago
Language
Python
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category