Skip to content

Commit

Permalink
chore: call out requirement for allowing commits to your pr branch in…
Browse files Browse the repository at this point in the history
… contributing guide (#27072)

The new markdown syntax is from [here](https://github.com/orgs/community/discussions/16925)

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
  • Loading branch information
kaizencc authored Sep 9, 2023
1 parent 0bac8a5 commit 0b241d9
Showing 1 changed file with 15 additions and 4 deletions.
19 changes: 15 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -487,7 +487,17 @@ CDK integration tests.

* Create a commit with your changes and push them to a
[fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo).
> Note: CDK core members can push to a branch on the AWS CDK repo (naming convention: `<user>/<feature-bug-name>`).
> [!IMPORTANT]
> We will not be able to accept your contribution if you do not allow commits to your PR branch, as it introduces
> friction in our review process and breaks our automation that syncs with the main branch. In these scenarios, we will close
> your pull request and ask that you recreate it with the necessary permissions.
> This means that you must contribute from a fork within your personal account (as opposed to an organization owned account) and also develop
> your contribution on a branch other than `main`. See
> [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)
> for more information.
> [!NOTE]
> CDK core members can push to a branch on the AWS CDK repo (naming convention: `<user>/<feature-bug-name>`).
* Create a [pull request on
Github](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork).
Expand Down Expand Up @@ -593,9 +603,10 @@ dependency.**

#### Adding new unconventional dependencies

> :warning: Do not add these. If there is a tool that you want to use in your
CDK constructs, see [Adding construct runtime
dependencies](#Adding-construct-runtime-dependencies).
> [!WARNING]
> Do not add these. If there is a tool that you want to use in your
> CDK constructs, see [Adding construct runtime
> dependencies](#Adding-construct-runtime-dependencies).
**For the aws-cdk an unconventional dependency is defined as any dependency that is not managed via the module's
`package.json` file.**
Expand Down

0 comments on commit 0b241d9

Please sign in to comment.