Skip to content

docs(contributing): add section explaining PR review process #36044

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs(contributing): add section explaining PR review process #36044

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ad8f124
docs(contributing): Add section explaining PR review process
pahud Nov 13, 2025
0707290
docs(contributing): Update community review process description
pahud Nov 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ Any code that you submit will be released under that license.
- [Step 2: Design (optional)](#step-2-design)
- [Step 3: Work your Magic](#step-3-work-your-magic)
- [Step 4: Pull Request](#step-4-pull-request)
- [What Happens After You Submit Your PR](#what-happens-after-you-submit-your-pr)
- [Step 5: Merge](#step-5-merge)
- [Breaking Changes](#breaking-changes)
- [Documentation](#documentation)
Expand Down Expand Up @@ -821,6 +822,45 @@ To disable coverage of specific lines, you can use:
console.log('This cannot be covered')
```

### What Happens After You Submit Your PR

After you submit your pull request, here's what to expect:

#### 1. CodeBuild CI Validation

Your PR will automatically trigger a CodeBuild CI pipeline that runs tests and validation checks. You are responsible for ensuring these checks pass:

* **Monitor the build status** - Check the PR status checks to see if CodeBuild passes or fails.
* **If the build fails** - You need to:
1. Click on the "Details" link next to the failed CodeBuild check to view the build logs
2. Identify the error message in the build log
3. Address the issue locally in your development environment
4. Commit and push the fixes to your PR branch
5. Repeat until the CodeBuild CI passes successfully

> [!IMPORTANT]
> Your PR cannot proceed to review until the CodeBuild CI check passes. If your build is failing without any work on it, your PR will be subject to closure for staleness.

* **Resolve merge conflicts** - After CI passes, check if your PR has any merge conflicts with the base branch. If conflicts exist, you must resolve them either:
- From the GitHub web UI using the conflict resolution tool, or
- Locally in your IDE by pulling the latest changes from the base branch and resolving conflicts manually

#### 2. Community Review Queue

Once your PR passes all CI checks with no conflicts:

* Your PR will be added to the [pending-community-review](https://github.com/aws/aws-cdk/pulls?q=is%3Apr+is%3Aopen+label%3Apr%2Fneeds-community-review) queue
* [Eligible community reviewers](https://github.com/aws/aws-cdk/wiki/CDK-Community-PR-Reviews) can review and provide feedback on your changes
* **One approving community review** will immediately bump your PR to the pending maintainer review queue

#### 3. Maintainer Review Queue

After receiving community approval:

* Your PR will be promoted to the [pending-maintainer-review](https://github.com/aws/aws-cdk/pulls?q=is%3Apr+is%3Aopen+label%3Apr%2Fneeds-maintainer-review) queue
* A CDK maintainer will perform a final review
* The maintainer may request additional changes or approve your PR for merge

### Step 5: Merge

* Make sure your PR builds successfully (we have CodeBuild setup to automatically build all PRs).
Expand Down
Loading