chore: clarify and prune design guidelines - #38463
Open
otaviomacedo wants to merge 2 commits into
Open
Conversation
Contributor
|
PRs without a linked issue will receive lower priority for review and merging. Please update the description to follow the PR template and include a line like |
aws-cdk-automation
added
the
pr/needs-maintainer-review
aws-cdk-automation
temporarily deployed
to
automation
July 31, 2026 15:54 — with 
GitHub Actions
Inactive
GitHub Actions
Inactive
aws-cdk-automation
temporarily deployed
to
automation
July 31, 2026 15:54 — with
GitHub Actions
Inactive
GitHub Actions
Inactive
kumsmrit
approved these changes
Aug 7, 2026
Contributor
|
Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
Contributor
Merge Queue Status
Waiting for any of
All merge conditions
Waiting for any of
All queue conditions
|
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
3 participants
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.
Editorial pass over
docs/DESIGN_GUIDELINES.md(with a small companion fix inAGENTS.md) to make the guidance clearer, self-explanatory, and free of stalereferences. No behavioral or code changes.
Highlights:
instanceof: explain whyinstanceofisunreliable in CDK (multiple copies of a package in
node_modules, multipleversions in one tree, jsii cross-language boundaries) rather than just
asserting the rule.
AGENTS.mdupdated to match: L1Cfn*checks areauto-generated via
spec2cdk; core classes likeApp/Stack/Stageimplement the pattern by hand.
changes or scope hierarchy" with a full explanation — changing a construct's
ID or scope position changes the derived logical ID, which replaces resources
and causes data loss, so such changes are breaking and only allowed in
-alphamodules.Fn::Sub: replaced the bare "Do not use FnSub" with the rationale (itembeds logical IDs as literal strings, bypassing CDK's reference/dependency
tracking) and the recommended alternatives.
libraries, the deCDK prop-type restrictions, and dangling awslint rule tags
(
[_awslint:...]) that no longer correspond to active lint rules.Trait implementations.
(replaced with a proper explanation of static factory methods), de-duplicated
the "be concise" props guidance, and minor wording/typo fixes.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license