diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md new file mode 100644 index 0000000..1213d69 --- /dev/null +++ b/.github/copilot-instructions.md @@ -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`. diff --git a/README.md b/README.md index 5c014f9..75b1a2c 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,7 @@ See [Browser Support](#browser-support) for details on the supported browser env ## Quickstart -Install the npm packare: `npm install @nevware21/ts-debug --save` +Install the npm package: `npm install @nevware21/ts-debug --save` And then just import the helpers and use them.