-
-
Notifications
You must be signed in to change notification settings - Fork 0
Add Copilot release instructions and README install guidance #435
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Copilot
wants to merge
4
commits into
main
Choose a base branch
from
copilot/add-copilot-instructions
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+32
−1
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| # Copilot instructions for `nevware21/ts-debug` | ||
|
|
||
| ## Repository overview | ||
|
|
||
| - This repository is a Rush monorepo. | ||
| - The publishable packages are `dbg` (`@nevware21/ts-debug`) and `providers` (`@nevware21/ts-debug-providers`). | ||
| - Root-level validation runs from the repository root with: | ||
| - `npm run lint` | ||
| - `npm run build` | ||
| - `npm run test` | ||
|
|
||
| ## Release checklist | ||
|
|
||
| When preparing a release, always: | ||
|
|
||
| 1. Use a commit title in the exact format `[Release] Increase version to x.y.z`. | ||
| 2. Update every required package manifest: | ||
| - `package.json` | ||
| - `dbg/package.json` | ||
| - `providers/package.json` | ||
| - Keep `providers/package.json` aligned with the new `@nevware21/ts-debug` dependency version. | ||
| 3. Update `README.md` for any release-related version references, but keep the Quickstart install command unpinned so it always installs the latest package version. | ||
| 4. Update `CHANGELIST.md`: | ||
| - include only the significant changes for the new version | ||
| - add a full changelist link when one is available | ||
| - preserve any existing unreleased details as-is; do not remove them and do not reduce them into the new version summary | ||
|
|
||
| ## Release packaging notes | ||
|
|
||
| - Root `npm run prep-release` runs `npm run cleanBuild` followed by `npm run npm-pack`. | ||
| - Root `npm run npm-pack` copies `README.md` and `LICENSE` into both publishable packages and then runs Rush `npm-pack`. |
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@copilot apply changes based on this feedback
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Applied in 9629439 — the README typo was fixed and the Quickstart line now reads
Install the npm package: npm install @nevware21/ts-debug --save.