Skip to content
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

Jump to bottom

chore: call out requirement for allowing commits to your pr branch in contributing guide #27072

Merged
merged 8 commits into from
Sep 9, 2023
Merged

chore: call out requirement for allowing commits to your pr branch in contributing guide #27072

Changes from 3 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
6d19ddb
Update CONTRIBUTING.md
kaizencc Sep 8, 2023
4b8e77f
Update CONTRIBUTING.md
kaizencc Sep 8, 2023
d092d9c
Update CONTRIBUTING.md
kaizencc Sep 8, 2023
7f9b124
Apply suggestions from code review
kaizencc Sep 8, 2023
23744a4
Update CONTRIBUTING.md
kaizencc Sep 8, 2023
6d10129
Merge branch 'main' into kaizencc-patch-8
kaizencc Sep 8, 2023
0d89b90
Update CONTRIBUTING.md
mrgrain Sep 9, 2023
4ea8609
Merge branch 'main' into kaizencc-patch-8
mergify[bot] Sep 9, 2023
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
19 changes: 15 additions & 4 deletions CONTRIBUTING.md
View file
Open in desktop
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**
kaizencc marked this conversation as resolved.
Show resolved Hide resolved
> 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 and also develop
kaizencc marked this conversation as resolved.
Show resolved Hide resolved
> 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**
kaizencc marked this conversation as resolved.
Show resolved Hide resolved
> 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**
kaizencc marked this conversation as resolved.
Show resolved Hide resolved
> 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