@@ -172,23 +172,47 @@ eval $(gp env -e)
172
172
173
173
## Pull Requests
174
174
175
+ Below is a flow chart that describes how your PR may be treated by repository maintainers:
176
+
177
+ ``` mermaid
178
+ graph TD
179
+ A[Incoming PR] -->B[Is an issue attached?]
180
+ B -->|Yes - labels copied from issue| C[Is it labeled P1?]
181
+ B -->|No - auto-labeled as P2| D["Is it trivial or effort/small?"]
182
+ C -->|Yes - P1| E[Is the PR build succeeding?]
183
+ C -->|No - it is P2| D
184
+ D -->|Yes| E
185
+ D -->|No| F[Unfortunately, we don't have the time to review <br/> PRs that are large effort and low priority.]
186
+ E -->|Yes| G[We will review your PR as soon as we can]
187
+ E -->|No| H[If the build is failing for more than 4 weeks <br/> without any work on it, we will close the PR.]
188
+ ```
189
+
190
+ Note that, if we do not have time to review your PR, it is not the end of the road. We are asking
191
+ for more community support on the attached issue before we focus our attention there. Any ` P2 ` issue
192
+ with 20 or more +1s will be automatically upgraded from ` P2 ` to ` P1 ` .
193
+
175
194
### Step 1: Find something to work on
176
195
177
- If you want to contribute a specific feature or fix you have in mind, look at active [ pull
178
- requests] ( https://github.com/aws/aws-cdk/pulls ) to see if someone else is already working on it. If not, you can start
179
- contributing your changes.
196
+ If you want to contribute a specific feature or fix you have in mind, look to see if an issue
197
+ already exists in our [ backlog] ( https://github.com/aws/aws-cdk/issues ) . If not, please contribute
198
+ a feature request or bug report prior to contributing the PR. We will triage this issue promptly,
199
+ and the priority of the issue (` P1 ` or ` P2 ` ) will give indication of how much attention your PR
200
+ may get.
201
+
202
+ It's not required to submit an issue first, but PRs that come in without attached issues will be
203
+ automatically labeled as ` P2 ` .
180
204
181
205
On the other hand, if you are here looking for an issue to work on, explore our [ backlog of
182
- issues] ( https://github.com/aws/aws-cdk/issues ) and find something that piques your interest. We have labeled all of our
183
- issues for easy searching.
184
- If you are looking for your first contribution, the [ 'good first issue'
185
- label ] ( https://github.com/aws/aws-cdk/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22 ) will be of help.
206
+ issues] ( https://github.com/aws/aws-cdk/issues ) and find something that piques your interest.
207
+ We have labeled all of our issues for easy searching. If you are looking for your first contribution,
208
+ the [ 'good first issue' label ] ( https://github.com/aws/aws-cdk/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22 )
209
+ will be of help.
186
210
187
211
It's a good idea to keep the priority of issues in mind when deciding what to
188
212
work on. If we have labelled an issue as ` P2 ` , it means it's something we won't
189
213
get to soon, and we're waiting on more feedback from the community (in the form
190
214
of +1s and comments) to give it a higher priority. A PR for a ` P2 ` issue may
191
- take us some time to review , especially if it involves a complex
215
+ be closed by a maintainer , especially if it involves a complex
192
216
implementation. ` P1 ` issues impact a significant number of customers, so we are
193
217
much more likely to give a PR for those issues prompt attention.
194
218
@@ -325,6 +349,9 @@ $ yarn watch & # runs in the background
325
349
326
350
* Once the pull request is submitted, a reviewer will be assigned by the maintainers.
327
351
352
+ * If the PR build is failing, update the PR with fixes until the build succeeds. You may have trouble getting attention
353
+ from maintainers if your build is failing, and after 4 weeks of staleness, your PR will be automatically closed.
354
+
328
355
* Discuss review comments and iterate until you get at least one "Approve". When iterating, push new commits to the
329
356
same branch. Usually all these are going to be squashed when you merge to master. The commit messages should be hints
330
357
for you when you finalize your merge commit message.
0 commit comments