diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 2ce8e6e..c56f757 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -8,9 +8,9 @@ assignees: '' ## Environment -- **Package Version**: (e.g., 0.2.0) +- **Package Version**: (from `npm ls @kkdev92/vscode-ext-kit`) - **VS Code Version**: (e.g., 1.138.0) -- **Node.js Version**: (e.g., 20.0.0) +- **Node.js Version**: (from `node --version`) - **OS**: (e.g., Windows 11, macOS 14, Ubuntu 24.04) ## Description diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 135180b..7874b3e 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -23,9 +23,8 @@ Fixes #(issue number) - [ ] I have read the [CONTRIBUTING](../CONTRIBUTING.md) guidelines - [ ] My code follows the project's coding standards - [ ] I have added tests that prove my fix/feature works -- [ ] All new and existing tests pass (`npm run test`) -- [ ] Linting passes (`npm run lint`) -- [ ] Type checking passes (`npm run typecheck`) +- [ ] `npm run quality` passes (format, type check, lint, tests with the coverage gate, knip, API docs) +- [ ] `npm run verify:package` passes, if the change can affect the packed package - [ ] I have updated documentation if needed ## Screenshots (if applicable) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 26b5438..7e95c47 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,11 +5,12 @@ not obvious from the code. ## Two branches, two codebases -- **v3** (`main`, `feat/v3-foundation`) — the extension _application framework_. +- **v3** (`main`) — the extension _application framework_: 3.0.0 and every major since. This is what you are looking at. -- **v2** (`v2-maintenance`) — the shipped `2.x` utility library. Still `latest` - on npm and still takes bug fixes. It is not present on the v3 line; recover a - file with `git checkout v2-maintenance -- `. +- **v2** (`v2-maintenance`) — the `2.x` utility library. It still takes bug + fixes, published under the `maintenance-2x` dist-tag; npm's `latest` has been + the v3 line since 3.0.0. It is not present on the v3 line; recover a file with + `git checkout v2-maintenance -- `. A change belongs on one line or the other. A v2 bug fix does not port to v3 by copying the file: v3's shape is different. @@ -36,7 +37,7 @@ repo. ```bash npm run build # tsc -b tsconfig.build.json (framework + mock kit) -npm run typecheck # build, then src+tests, then the README samples +npm run typecheck # build, then src+tests, the README samples and both fixtures npm test # vitest run npm run test:coverage # the same suite, with the coverage gate npm run lint # type-aware ESLint over src + tests, --max-warnings 0 @@ -44,7 +45,7 @@ npm run format # prettier npm run knip # dead code npm run docs:api # TypeDoc into docs/api; warnings are errors npm run verify:package # pack, install into a throwaway consumer, import every subpath -npm run quality # typecheck + lint + test:coverage + knip + docs:api — the gate CI runs +npm run quality # format:check + typecheck + lint + test:coverage + knip + docs:api — the gate CI runs ``` `tsc -b --noEmit` does not work (TS6310: project references need `composite`, and