Skip to content

Commit

Permalink
chore: note about code snippets that uses consumers (aws#17645)
Browse files Browse the repository at this point in the history
----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
  • Loading branch information
Niranjan Jayakar authored and Andrew Beresford committed Nov 29, 2021
1 parent dd5e12d commit b4e82c1
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -556,6 +556,12 @@ contain three slashes to achieve the same effect:
For a practical example of how making sample code compilable works, see the
`aws-ec2` package.

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

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

0 comments on commit b4e82c1

Please sign in to comment.