Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions .github/instructions/changelog.instructions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
applyTo: "CHANGELOG.md"
description: "Changelog format and conventions based on Keep a Changelog"
---

# Changelog Format

This project follows [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) and [Semantic Versioning](https://semver.org/).

## Structure

- New entries go under `## [Unreleased]`.
- Released versions use `## [X.Y.Z] - YYYY-MM-DD`.
- Group entries by type: `Added`, `Changed`, `Deprecated`, `Removed`, `Fixed`, `Security`.

## Entry format

- One line per PR: concise description ending with `(#PR_NUMBER)`.
- Credit external contributors inline: `— by @username (#PR_NUMBER)`.
- Combine related PRs into a single line when they form one logical change: `(#251, #256, #258)`.
- Use backticks for code references: commands, file names, config keys, classes.

## Rules

- Every merged PR that changes code, tests, docs, or dependencies must have a changelog entry.
- Do NOT include version-bump or release-machinery PRs (e.g., "chore: bump to vX.Y.Z").
- When releasing, move Unreleased entries into a new versioned section — never delete them.
17 changes: 17 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Added

- Diff-aware `apm install` — manifest as source of truth: removed packages, ref/version changes, and MCP config drift in `apm.yml` all self-correct on the next `apm install` without `--update` or `--force`; introduces `drift.py` with pure helper functions (#260)
- `DiagnosticCollector` for structured install diagnostics (#267)
- Detailed file-level logging to `apm unpack` command (#252)
- Astro Starlight documentation site with narrative redesign (#243)
Copy link

Copilot AI Mar 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This bullet conflates two separate PRs: #243 is the Starlight docs site migration, while the “narrative redesign” work is in #258. To keep the changelog accurate, split this into distinct entries and ensure #258 is referenced on the correct line/section (likely under Changed).

This issue also appears on line 27 of the same file.

Copilot uses AI. Check for mistakes.

### Fixed

- Resolve WinError 32 during sparse-checkout fallback on Windows — by @JanDeDobbeleer (#235)
- CLI consistency: docs alignment, emoji removal, `show_default` flags (#266)

### Changed

- Minimum Python version bumped to 3.10; Black upgraded to 26.3.1 (#269)
- Refactor `cli.py` and `apm_package.py` into focused modules — by @sergio-sisternes-epam (#224)
- Revamp README as storefront for documentation site (#251, #256, #258)
- Remove duplicated content from CLI reference page (#261)
- Bump devalue 5.6.3 → 5.6.4 in docs (#263)
- Primitives models coverage 78% → 100%; add discovery and parser coverage tests (#240, #254)

## [0.7.7] - 2026-03-10

Expand Down
Loading