Agent skill

release-standards

Semantic versioning and changelog formatting for software releases. Use when: preparing releases, updating version numbers, writing changelogs. Keywords: version, release, changelog, semver, major, minor, patch, 版本, 發布, 變更日誌.

Stars 44
Forks 10

Install this agent skill to your Project

npx add-skill https://github.com/AsiaOstrich/universal-dev-skills/tree/main/skills/release-standards

SKILL.md

Release Standards

This skill provides semantic versioning and changelog formatting standards.

Quick Reference

Semantic Versioning Format

MAJOR.MINOR.PATCH[-PRERELEASE][+BUILD]

Examples:
2.3.1
1.0.0-alpha.1
3.2.0-beta.2+20250112

Version Incrementing Rules

Component When to Increment Example
MAJOR Breaking changes 1.9.5 → 2.0.0
MINOR New features (backward-compatible) 2.3.5 → 2.4.0
PATCH Bug fixes (backward-compatible) 3.1.2 → 3.1.3

Pre-release Identifiers

Identifier Stability Audience
alpha Unstable Internal team
beta Mostly stable Early adopters
rc Stable Beta testers

CHANGELOG Categories

Category Usage
Added New features
Changed Changes in existing functionality
Deprecated Soon to be removed
Removed Removed features
Fixed Bug fixes
Security Vulnerability fixes

Detailed Guidelines

For complete standards, see:

  • Semantic Versioning Guide
  • Changelog Format

CHANGELOG Entry Format

markdown
## [VERSION] - YYYY-MM-DD

### Added
- Add user dashboard with customizable widgets (#123)

### Changed
- **BREAKING**: Change API response format from XML to JSON

### Fixed
- Fix memory leak when processing large files (#456)

### Security
- Fix SQL injection vulnerability (CVE-2025-12345)

Breaking Changes

Mark breaking changes with BREAKING prefix:

markdown
### Changed
- **BREAKING**: Remove deprecated `getUserById()`, use `getUser()` instead

Git Tagging

bash
# Create annotated tag (recommended)
git tag -a v1.2.0 -m "Release version 1.2.0"

# Push tag to remote
git push origin v1.2.0

Version Ordering

1.0.0-alpha.1 < 1.0.0-alpha.2 < 1.0.0-beta.1 < 1.0.0-rc.1 < 1.0.0

Configuration Detection

This skill supports project-specific configuration.

Detection Order

  1. Check CONTRIBUTING.md for "Disabled Skills" section
    • If this skill is listed, it is disabled for this project
  2. Check CONTRIBUTING.md for "Release Standards" section
  3. If not found, default to Semantic Versioning and Keep a Changelog format

First-Time Setup

If no configuration found and context is unclear:

  1. Ask the user: "This project hasn't configured release standards. Would you like to use Semantic Versioning?"
  2. After user selection, suggest documenting in CONTRIBUTING.md:
markdown
## Release Standards

### Versioning
This project uses **Semantic Versioning** (MAJOR.MINOR.PATCH).

### Changelog
This project follows **Keep a Changelog** format.

Configuration Example

In project's CONTRIBUTING.md:

markdown
## Release Standards

### Versioning
This project uses **Semantic Versioning** (MAJOR.MINOR.PATCH).

### Changelog
This project follows **Keep a Changelog** format.

### Release Process
1. Update version in package.json
2. Update CHANGELOG.md
3. Create git tag with `v` prefix (e.g., v1.2.0)
4. Push tag to trigger release workflow

License: CC BY 4.0 | Source: universal-dev-standards

Expand your agent's capabilities with these related and highly-rated skills.

AsiaOstrich/universal-dev-skills

ai-collaboration-standards

Prevent AI hallucination and ensure evidence-based responses when analyzing code or making suggestions. Use when: analyzing code, making recommendations, providing options, or when user asks about confidence/certainty. Keywords: certainty, assumption, inference, evidence, source, 確定性, 推測, 假設, 來源, 證據.

44 10
Explore
AsiaOstrich/universal-dev-skills

requirement-assistant

Guide requirement writing, user story creation, and feature specification. Use when: writing requirements, user stories, issues, feature planning. Keywords: requirement, user story, issue, feature, specification, 需求, 功能規劃, 規格.

44 10
Explore
AsiaOstrich/universal-dev-skills

testing-guide

Testing pyramid and test writing standards for UT/IT/ST/E2E. Use when: writing tests, discussing test coverage, test strategy, or test naming. Keywords: test, unit, integration, e2e, coverage, mock, 測試, 單元, 整合, 端對端.

44 10
Explore
AsiaOstrich/universal-dev-skills

documentation-guide

Guide documentation structure, README content, and project documentation best practices. Use when: creating README, documentation, docs folder, project setup. Keywords: README, docs, documentation, CONTRIBUTING, CHANGELOG, 文件, 說明文件.

44 10
Explore
AsiaOstrich/universal-dev-skills

commit-standards

Format commit messages following conventional commits standard. Use when: writing commit messages, git commit, reviewing commit history. Keywords: commit, git, message, conventional, 提交, 訊息, feat, fix, refactor.

44 10
Explore
AsiaOstrich/universal-dev-skills

git-workflow-guide

Guide Git branching strategies, branch naming, and merge operations. Use when: creating branches, merging, pull requests, Git workflow questions. Keywords: branch, merge, PR, pull request, GitFlow, GitHub Flow, 分支, 合併, 工作流程.

44 10
Explore

Didn't find tool you were looking for?

Be as detailed as possible for better results