Skip to content

Commit d85f9a7

Browse files
authored
docs: clarify pull request source branch a little more (#27625)
---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
1 parent df24d22 commit d85f9a7

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

CONTRIBUTING.md

+7-9
Original file line numberDiff line numberDiff line change
@@ -485,16 +485,14 @@ CDK integration tests.
485485

486486
### Step 4: Pull Request
487487

488-
* Create a commit with your changes and push them to a
489-
[fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo).
488+
* Create a [fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) of the CDK repository.
489+
* Create a new branch for your change, and push the change commits on it.
490490
> [!IMPORTANT]
491-
> We will not be able to accept your contribution if you do not allow commits to your PR branch, as it introduces
492-
> friction in our review process and breaks our automation that syncs with the main branch. In these scenarios, we will close
493-
> your pull request and ask that you recreate it with the necessary permissions.
494-
> This means that you must contribute from a fork within your personal account (as opposed to an organization owned account) and also develop
495-
> your contribution on a branch other than `main`. See
496-
> [Allowing changes to a pull request branch created from a fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork)
497-
> for more information.
491+
> Your pull request must be based off of a branch in a personal account (not an organization owned account, and not the `main` branch).
492+
> You must also have the setting enabled that [allows the CDK team to push changes to your branch](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork) (this setting is enabled by default for personal accounts,
493+
> and cannot be enabled for organization owned accounts).
494+
> The reason for this is that our automation needs to synchronize your branch with our `main` after it has been approved, and
495+
> we cannot do that if we cannot push to your branch.
498496
499497
> [!NOTE]
500498
> CDK core members can push to a branch on the AWS CDK repo (naming convention: `<user>/<feature-bug-name>`).

0 commit comments

Comments
 (0)