Add GitHub Copilot instructions for project conventions and release process#498
Merged
Conversation
…cess Agent-Logs-Url: https://github.com/nevware21/ts-async/sessions/e92729ba-4324-4b6a-9a7b-3ba7d1b3d89d Co-authored-by: nev21 <82737406+nev21@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add copilot onboarding instructions and release updates
Add GitHub Copilot instructions for project conventions and release process
May 11, 2026
nev21
approved these changes
May 11, 2026
nev21
approved these changes
May 11, 2026
There was a problem hiding this comment.
Pull request overview
Adds a repository-specific Copilot instruction document to capture project conventions and the release process requirements that aren’t easily inferred from the codebase.
Changes:
- Introduces
.github/copilot-instructions.mddescribing the library purpose, monorepo layout, and key build/lint/test commands. - Documents the expected release workflow, including files to update and
CHANGELIST.mdformatting rules. - Summarizes coding/testing conventions (ES5 compatibility, minification-oriented exports, CI test environments).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
nev21
approved these changes
May 11, 2026
Comment on lines
+40
to
+43
| Full rebuild (clean build + tests + size checks): | ||
| ```bash | ||
| npm run rebuild | ||
| ``` |
|
|
||
| ## Changelog | ||
|
|
||
| # v{new-version} {Month} {Day}, {Year} |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #498 +/- ##
=======================================
Coverage 97.56% 97.56%
=======================================
Files 27 27
Lines 1439 1439
Branches 337 339 +2
=======================================
Hits 1404 1404
Misses 35 35 🚀 New features to boost your workflow:
|
nevware21-bot
approved these changes
May 11, 2026
Contributor
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.
Adds
.github/copilot-instructions.mdto give Copilot context about this repo's conventions, with particular focus on the release process which has specific requirements that aren't obvious from code alone.What's documented
lib/), what gets published to npmnpm run lint,npm run build,npm test[Release] Increase version to x.y.zpackage.jsonfiles,README.md(recommended version range),CHANGELIST.mdCHANGELIST.mdrules: preserve unreleased items verbatim, move them under a new versioned heading, append a GitHub compare link (v{prev}...v{new}), leave an empty# Unreleasedsection for future changes