Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Jan 3, 2026

CHANGELOG.md is auto-generated during releases via release.sh using git commit history. Coding agents need explicit instructions not to modify it in pull requests.

Changes

Added instructions in three locations within .github/copilot-instructions.md:

  • Root Directory Files: Updated CHANGELOG.md description to indicate it's auto-generated and should not be modified
  • Before Committing checklist: Added item Added new benchmarks #7 explicitly prohibiting CHANGELOG.md modifications
  • Common Pitfalls: Added item Added new benchmarks #7 explaining the automated release process and why manual edits are inappropriate

The instructions use emphatic language ("DO NOT MODIFY") to ensure clarity and prevent accidental updates during regular development work.

Original prompt

This section details on the original issue you should resolve

<issue_title>Add instructions not to update CHANGELOG.md</issue_title>
<issue_description>CHANGELOG.md will be updated during the release process, and should not be modified in pull requests. Instructions for coding agents should contain this.</issue_description>

Comments on the Issue (you are @copilot in this section)


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

@coderabbitai
Copy link

coderabbitai bot commented Jan 3, 2026

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Comment @coderabbitai help to get the list of available commands and usage tips.

Co-authored-by: samueltardieu <44656+samueltardieu@users.noreply.github.com>
Copilot AI changed the title [WIP] Add instructions not to update CHANGELOG.md docs(instructions): add explicit instruction not to modify CHANGELOG.md Jan 3, 2026
Copilot AI requested a review from samueltardieu January 3, 2026 01:34
@samueltardieu samueltardieu marked this pull request as ready for review January 3, 2026 01:34
@samueltardieu samueltardieu added this pull request to the merge queue Jan 3, 2026
Merged via the queue into main with commit 5be0140 Jan 3, 2026
14 checks passed
@samueltardieu samueltardieu deleted the copilot/add-instructions-for-changelog branch January 3, 2026 01:40
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 instructions not to update CHANGELOG.md

2 participants