Skip to content

Add changelog update instructions to Copilot guidelines#9

Merged
HeyItsGilbert merged 2 commits intomainfrom
copilot/fix-8
Aug 12, 2025
Merged

Add changelog update instructions to Copilot guidelines#9
HeyItsGilbert merged 2 commits intomainfrom
copilot/fix-8

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Aug 12, 2025

This PR adds comprehensive changelog update instructions to the Copilot guidelines to ensure all pull requests include proper changelog updates following the Keep a Changelog format.

Changes Made

Enhanced Copilot Instructions

  • Added a new "Changelog Updates" section to the Development Workflow
  • Updated the "Making Code Changes" process to include changelog updates as a required step
  • Enhanced "Common Validation Steps" with changelog verification checklist

Key Requirements Added

  • Mandatory for every PR: Update CHANGELOG.md in the "Unreleased" section
  • Standard format: Follow Keep a Changelog format
  • Clear categories: Use appropriate sections (Added, Changed, Deprecated, Removed, Fixed, Security)
  • User-focused descriptions: Write clear, concise entries that help users understand changes

Documentation Structure

The instructions include:

  • Clear process steps for updating the changelog
  • Complete list of changelog categories with descriptions
  • Example changelog entry showing proper formatting
  • Validation checklist to ensure quality

Example Usage

## [Unreleased]

### Added
- New PowerShell localization parsing feature for multi-language support

### Fixed
- Resolved issue with decoration provider not updating on file changes

This ensures consistent changelog maintenance across all contributions while maintaining the existing high-quality documentation standards in the repository.

Fixes #8.


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: HeyItsGilbert <615265+HeyItsGilbert@users.noreply.github.com>
Copilot AI changed the title [WIP] Add Changelog Update to Copilot Instructions Add changelog update instructions to Copilot guidelines Aug 12, 2025
Copilot AI requested a review from HeyItsGilbert August 12, 2025 15:00
@HeyItsGilbert HeyItsGilbert marked this pull request as ready for review August 12, 2025 15:08
@HeyItsGilbert HeyItsGilbert merged commit 1f01b40 into main Aug 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add Changelog Update to Copilot Instructions

2 participants