Docs: [AEA-0000] - couple of suggestions after cdk work#11
Open
tstephen-nhs wants to merge 3 commits intomainfrom
Open
Docs: [AEA-0000] - couple of suggestions after cdk work#11tstephen-nhs wants to merge 3 commits intomainfrom
tstephen-nhs wants to merge 3 commits intomainfrom
Conversation
Contributor
|
This PR is linked to a ticket in an NHS Digital JIRA Project. Here's a handy link to the ticket: AEA-0000 |
There was a problem hiding this comment.
Pull request overview
Updates internal Copilot guidance docs to better align TypeScript/CDK recommendations with preferred testing patterns and linting expectations.
Changes:
- Add TypeScript guidance to avoid using the
voidoperator as a lint-warning suppression mechanism. - Add TypeScript style guidance preferring
Array<T>overT[]for array annotations. - Add CDK unit testing guidance focused on synth/assertion tests and add a CDK test command to validation steps.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| .github/instructions/languages/typescript.instructions.md | Adds TypeScript-specific style guidance to steer generated/reviewed code away from patterns that can trigger tooling warnings. |
| .github/instructions/languages/cdk.instructions.md | Documents recommended CDK unit test approaches (synth-based assertions) and adds a workspace test command for CDK packages. |
anthony-nhs
reviewed
Apr 13, 2026
| - Keep assertions light-touch and stable, such as resource counts and a small number of important properties. | ||
| - Avoid mocking AWS resources or writing tests that attempt to exercise live AWS behaviour. | ||
| - CDK constructs suitable for reuse should be placed in `eps-cdk-utils` repo. | ||
| - Smaller CDK constructs may be included here and should have associated tests. |
Collaborator
There was a problem hiding this comment.
This gets copied to all repos so saying 'Smaller CDK constructs may be included here' does not make sense when this file will also be in eps-cdk-utils repo
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Details