docs: add release PR instructions to copilot instructions#556
Merged
Conversation
Agent-Logs-Url: https://github.com/nevware21/ts-utils/sessions/a4504069-2a75-45d1-87fa-dca01c8e5ed3 Co-authored-by: nev21 <82737406+nev21@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update copilot instructions to include release instructions
docs: add release PR instructions to copilot instructions
May 11, 2026
nev21
approved these changes
May 11, 2026
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #556 +/- ##
=======================================
Coverage 99.46% 99.46%
=======================================
Files 145 145
Lines 4271 4271
Branches 938 915 -23
=======================================
Hits 4248 4248
Misses 23 23 🚀 New features to boost your workflow:
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the repository’s GitHub Copilot guidance by adding a “Creating a Release PR” section to standardize how release PRs are prepared (title format, required version bumps, and CHANGELOG entry rules) to reduce inconsistent release commits.
Changes:
- Adds a required release PR title format (
[Release] Increase version to <new-version>). - Documents which files must be updated for a release (
package.json,lib/package.json,README.md,CHANGELOG.md). - Adds CHANGELOG rules (significant changes focus, compare link requirement, preserve any “Unreleased” sections) plus a pre-submission checklist.
Comment on lines
+327
to
+333
| #### CHANGELOG.md Entry Format | ||
| The date format should use the full month name followed by the day with ordinal suffix and the four-digit year (e.g., `February 26th, 2026`): | ||
| ```markdown | ||
| # v<new-version> <Month> <ordinal-day>, <Year> | ||
|
|
||
| ## Changelog | ||
|
|
Comment on lines
+332
to
+348
| ## Changelog | ||
|
|
||
| ### Features | ||
|
|
||
| - Description of new features | ||
|
|
||
| ### Bug Fixes | ||
|
|
||
| - Description of bug fixes | ||
|
|
||
| ### Breaking Changes | ||
|
|
||
| - Description of any breaking changes (if applicable) | ||
|
|
||
| ### Repository Improvements | ||
|
|
||
| - Description of any significant repository/CI improvements (if applicable) |
nevware21-bot
approved these changes
May 11, 2026
Contributor
nevware21-bot
left a comment
nevware21-bot
left a comment
There was a problem hiding this comment.
Approved by nevware21-bot
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Copilot instructions lacked guidance on how to create a release PR, leading to inconsistent release commits and missing file updates.
Changes
.github/copilot-instructions.mdcovering:[Release] Increase version to <new-version>package.json(root),lib/package.json,README.md,CHANGELOG.mdMonth ordinal-day, Year(e.g.,May 15th, 2026)