-
Notifications
You must be signed in to change notification settings - Fork 4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(doc): update the contributing guide with more details (#25321)
This PR explains how to `Verify your fix by deployment` before you submit a pull request. When contributors complete their hack on any modules under `aws-cdk-lib`, it's unclear to them how to verify and ensure their fix can successfully synthesize and deploy in a real AWS environment. This PR explains how to do that with more details including: 1. How to write a minimal cdk App with your fix to verify it in your AWS account 2. How to run all unit tests against your hack 3. How to run a single unit test against your hack 4. How to run all integ tests against your hack 5. How to run a single integ test against your hack With the additional content, contributors will be able to iterate their development easily and ensure their hack can successfully deploy in their own AWS accounts as expected before they submit their PRs. Closes #25196 ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
- Loading branch information
Showing
1 changed file
with
104 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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