Skip to content

Latest commit

 

History

History
80 lines (57 loc) · 3.08 KB

CONTRIBUTING.md

File metadata and controls

80 lines (57 loc) · 3.08 KB

Contributing to the AWS Cloud Development Kit Toolkit

The AWS Cloud Development Kit (AWS CDK) is an open-source software development framework that you can contribute to. We value community contributions which significantly impact the development of the AWS CDK. This document will guide you through learning about contributions, getting started with creating contributions, and understanding what is required to ensure that your efforts are impactful and your contribution process goes smoothly.

Thank you for your interest in contributing to the AWS CDK! We look forward to working with you to improve the AWS CDK for everyone. ❤️

The AWS CDK is released under the Apache license. Any code that you submit will be released under that license.

Contribution process

The process of the aws-cdk Contributing Guide around finding items to work and submitting Pull Requests also applies to this repository. This contributing guide will focus on technical aspects.

Prerequisites

We recommend that you use Visual Studio Code to work on the CDK. We use ESLint to keep our code consistent in terms of style and reducing defects. We recommend installing the ESLint extension as well.

Getting started

This is a projen-managed repository. After checkout, run the following:

$ yarn
$ yarn build

This will build and unit test all packages.

Integration tests

Integration tests for this package are in a separate repository. They can be found here:

https://github.com/aws/aws-cdk-cli-testing

To make a change that involves the integration tests, make sure you have this package checked out.

Run the tests locally by doing the following:

$ cd /path/to/aws-cdk-cli-testing/packages/@aws-cdk-testing/cli-integ
$ bin/run-suite -s ../../../../aws-cdk-cli cli-integ-tests -f 2.179.0 -t 'TEST NAME'

-s points to the root of the aws-cdk-cli repository, -f is the version of the framework to use for testing.

Submitting a PR that involves changes to integration tests

When you make a change to both the CLI and the integration tests, you must submit 2 PRs to the two repositories, and follow the following process:

  1. Initially the integ tests on the aws-cdk-cli-testing repository will fail because the currently published CLI version won't support the new feature yet.
  2. Test the changes locally
  3. Merge the CLI PR first.
  4. Release the CLI.
  5. Merge the aws-cdk-cli-testing PR.
  6. Release the testing PR.

We will build automation to make this process smoother as soon as possible, but this is what it is for now.