Skip to content

Commit 8f12f3f

Browse files
authored
Merge branch 'master' into epolon/eks-snapshot-test
2 parents 6a1daf3 + 9eedaa0 commit 8f12f3f

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -556,6 +556,12 @@ contain three slashes to achieve the same effect:
556556
For a practical example of how making sample code compilable works, see the
557557
`aws-ec2` package.
558558

559+
> ⚠️ NOTE: README files often contain code snippets that refer to modules that are consumers
560+
> of the current module, and hence not present in the current module's dependency closure.
561+
> Compilation of these snippets will fail if the module referenced has not been built.
562+
> For the best experience when working on snippets, a full build of the CDK repo is required.
563+
> However, it may be prudent to "build up" these modules as required.
564+
559565
#### Recommendations
560566

561567
In order to offer a consistent documentation style throughout the AWS CDK

0 commit comments

Comments
 (0)