Skip to content

Commit 1a85928

Browse files
Merge staging into feature/featureDev-codegen
2 parents 6fa76e4 + 1e41dcf commit 1a85928

15 files changed

+609
-477
lines changed

CONTRIBUTING.md

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ codebase and sending pull requests.
1010

1111
This project is set up as a typescript monorepo. The documentation throughout this project
1212
is referring to the subprojects [`packages/toolkit/`](./packages/toolkit/) and [`packages/core/`](./packages/core/).
13-
Please see [ARCHITECTURE.md](./docs/ARCHITECTURE.md#monorepo-structure) to understand the
14-
structure of thispackage before contributing.
13+
See [arch_develop.md](./docs/arch_develop.md#monorepo-structure) to understand the
14+
structure of this package before contributing.
1515

1616
### Find things to do
1717

@@ -88,6 +88,7 @@ You can also use these NPM tasks (see `npm run` for the full list):
8888
8989
### Guidelines
9090
91+
- Architecture: [arch_overview.md](./docs/arch_overview.md)
9192
- Project patterns and practices: [CODE_GUIDELINES.md](./docs/CODE_GUIDELINES.md)
9293
- [VS Code Extension Guidelines](https://code.visualstudio.com/api/references/extension-guidelines)
9394
- [Webview guidance](https://code.visualstudio.com/api/ux-guidelines/webviews)
@@ -247,26 +248,24 @@ To send a pull request:
247248
248249
### Changelog
249250
250-
Pull requests that change customer-facing behavior (in any _describable_ way) should include
251-
a changelog item(s). Update the changelog via:
251+
Pull requests that change **customer-impacting behavior** must include a changelog item(s). Run this command:
252252
253253
npm run newChange
254254
255255
> [!TIP]
256-
> To update an _existing_ changelog item, just edit its `.changes/next-release/….json` file, you
257-
> don't need to re-run `npm run newChange`.
258-
259-
Guidelines:
260-
261-
- If there are multiple unrelated changes, run `npm run newChange` for each change.
262-
- Describe the change in a way that is meaningful to the _customer_.
263-
- ❌ `Remove the cache when the connection wizard is re-launched`
264-
- ✅ `Connection wizard sometimes shows the old (stale) connection`
265-
- "Bug Fix" changes should describe the _problem being fixed_. This tends to produce simpler,
266-
more-intuitive descriptions. It's redundant to say "Fixed" in the description, because the
267-
generated changelog will say that. Example:
268-
- ❌ `Fixed S3 bug which caused filenames to be uppercase`
269-
- ✅ `S3 filenames are always uppercase`
256+
>
257+
> - Describe the change in a way that is _meaningful to the customer_. If you can't describe the _customer impact_ then it probably shouldn't be in the changelog.
258+
> - ❌ `Update telemetry definitions` (not customer-impacting)
259+
> - ✅ `Faster startup after VSCode restarts`
260+
> - ❌ `Remove the cache when the connection wizard is re-launched` (code internals are not relevant to customers)
261+
> - ✅ `Connection wizard sometimes shows the old (stale) connection`
262+
> - "Bug Fix" changes should describe the _problem being fixed_. This tends to produce simpler,
263+
> more-intuitive descriptions. It's redundant to say "Fixed" in the description, because the
264+
> generated changelog will say that. Example:
265+
> - ❌ `Fixed S3 bug which caused filenames to be uppercase`
266+
> - ✅ `S3 filenames are always uppercase`
267+
> - To update an _existing_ changelog item, just edit its `.changes/next-release/….json` file, you don't need to re-run `npm run newChange`.
268+
> - If there are multiple unrelated changes, run `npm run newChange` for each change.
270269
271270
### Commit messages
272271
@@ -597,6 +596,9 @@ There are several ways to make pre-production changes available on a "preview" o
597596
also forces the Toolkit to declare version `99.0` (since "private beta" has no semver and to
598597
avoid unwanted auto-updating from VSCode marketplace). Beta builds of the Toolkit automatically
599598
query the URL once per session per day.
599+
- Beta users may want to run the `Extensions: Disable Auto Update for All Extensions` command
600+
[disable VSCode's auto-update feature](https://code.visualstudio.com/docs/editor/extension-marketplace#_extension-autoupdate),
601+
to avoid ovewriting the beta Toolkit with the marketplace release.
600602

601603
## Code of Conduct
602604

docs/ARCHITECTURE.md

Lines changed: 1 addition & 420 deletions
Large diffs are not rendered by default.

docs/CODE_GUIDELINES.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ that is a net cost.
117117

118118
### Exceptions
119119

120-
_See also [ARCHITECTURE.md](./ARCHITECTURE.md#exceptions)._
120+
_See also [arch_develop.md](./arch_develop.md#exceptions)._
121121

122122
- Bubble-up error conditions, do not sink them to random hidden places (such as
123123
logs only), expecting callers to figure out the failure mode. If a caller

docs/TESTPLAN.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ The test suite has the following categories of tests:
4646
## Test files
4747

4848
Currently, most if not all testing code lives in the subproject `packages/core/`.
49-
For more information, see [ARCHITECTURE.md](./docs/ARCHITECTURE.md#monorepo-structure)
49+
For more information, see [arch_develop.md](./arch_develop.md#monorepo-structure)
5050

5151
- `src/test/` : unit tests
5252
- `src/test/globalSetup.test.ts` :

0 commit comments

Comments
 (0)