You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Problem:
- We often don't know where to document various things (e.g. "which env vars do we use").
- We don't have an explanation of how the "remote connect" subsystem works.
Solution:
- Create skeletons for various "views" of the architecture based on the [4+1 architectural views](https://en.wikipedia.org/wiki/4%2B1_architectural_view_model) concept.
- TL;DR: It's basically just a place to put stuff.
- Example: env vars would go in the "runtime view".
- Add a "remote connect" section to the "features view" (aka "logical view").
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:
252
252
253
253
npm run newChange
254
254
255
255
> [!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.
0 commit comments