Changelog Standards

Name: Changelog Standards
Author: joealmond

Formatting rules for CHANGELOG entries — the project's universal history

by joealmond(0) 0 installs

Free

Free account. Installing gives you the manifest plus copy-paste snippets.

See reviews

About

Instruction file imported from joealmond/autodocs (.github/instructions/changelog.instructions.md). Copyright stays with the author.

Changelog Standards

When editing CHANGELOG.md:

Entry Format

## [Unreleased]

### Added
- Short description of what was added

### Changed
- Short description of what changed

### Fixed
- Short description of what was fixed

### Removed
- Short description of what was removed

Rules

Group entries under: Added, Changed, Fixed, Removed
Each entry is ONE line — a brief, clear summary (not a paragraph)
Use past tense: "Added X" not "Add X"
Reference GitHub Issues when applicable: Closes #42
Newest entries go at the top, under ## [Unreleased]
When releasing, move unreleased entries under a version heading: ## [1.2.0] — YYYY-MM-DD
Never delete old entries — the changelog is append-only history
If unsure whether a change deserves an entry: it does. Err on the side of documenting.

Use it

Copy one of these into your project. Installing also returns the manifest and these snippets.

yaml

targets:
  - https://api.opensmartroute.ai/api/v1/registry/joealmond-autodocs-changelog-instructions/manifest   # or paste the manifest below

Manifest

An Open Capability Manifest: the router reads it to know what this does, what it costs and when to pick it.

joealmond-autodocs-changelog-instructions.ocm.jsonjson

{
  "ocm": "1",
  "id": "joealmond-autodocs-changelog-instructions",
  "kind": "skill",
  "name": "Changelog Standards",
  "description": "Formatting rules for CHANGELOG entries — the project's universal history",
  "publisher": "joealmond",
  "version": "1.0.0",
  "capabilities": {
    "domains": [
      "general"
    ],
    "tags": [
      "skill-md",
      "github-instructions"
    ],
    "languages": [
      "en"
    ]
  },
  "quality_prior": 0.6,
  "examples": [
    "Formatting rules for CHANGELOG entries — the project's universal history"
  ],
  "primary": false,
  "metadata": {
    "source": {
      "provider": "github-instructions",
      "repository": "https://github.com/joealmond/autodocs",
      "path": ".github/instructions/changelog.instructions.md",
      "ref": "b69f41564eec61398ef129fad84367414388a2a5",
      "url": "https://github.com/joealmond/autodocs/blob/b69f41564eec61398ef129fad84367414388a2a5/.github/instructions/changelog.instructions.md",
      "key": "joealmond/autodocs/.github/instructions/changelog.instructions.md"
    },
    "applies_to": "**/CHANGELOG*"
  },
  "instructions": "# Changelog Standards\n\nWhen editing `CHANGELOG.md`:\n\n## Entry Format\n\n```markdown\n## [Unreleased]\n\n### Added\n- Short description of what was added\n\n### Changed\n- Short description of what changed\n\n### Fixed\n- Short description of what was fixed\n\n### Removed\n- Short description of what was removed\n```\n\n## Rules\n\n- Group entries under: **Added**, **Changed**, **Fixed**, **Removed**\n- Each entry is ONE line — a brief, clear summary (not a paragraph)\n- Use past tense: \"Added X\" not \"Add X\"\n- Reference GitHub Issues when applicable: `Closes #42`\n- Newest entries go at the top, under `## [Unreleased",
  "cost": {
    "context_tokens": 212
  }
}

Fetch it by URL: GET /api/v1/registry/joealmond-autodocs-changelog-instructions/manifest?version=1.0.0

About

Changelog Standards

Entry Format

Rules

Use it

Manifest

Reviews