3.04 kBMarkdownView Raw
1# Contributing to the AWS ECS and AWS ECS Patterns modules
3Hiya! Thanks for your interest in contributing to the ECS modules! The [ECS
4Developer Experience](https://github.com/orgs/aws/teams/aws-ecs-devx) team
5currently owns the following construct libraries:
7- [@aws-cdk/aws-ecs](https://github.com/aws/aws-cdk/tree/master/packages/%40aws-cdk/aws-ecs):
8 the main construct library for AWS ECS
9- [@aws-cdk/aws-ecs-patterns](https://github.com/aws/aws-cdk/tree/master/packages/%40aws-cdk/aws-ecs-patterns):
10 a set of simplified, higher-level constructs based on common container-based
11application architectures. Great for first-time container developers!
12- [@aws-cdk-containers/ecs-service-extensions](https://github.com/aws/aws-cdk/tree/master/packages/%40aws-cdk-containers/ecs-service-extensions):
13 a set of ECS constructs that promote best practices for container
14infrastructure by using composable add-ons, such as load balancers and sidecar
15containers used for tracing and metric logging. More suitable for advanced
16container configuration.
18## Find something to work on
20Issues related to ECS, ECS Patterns, and ECS Service extensions are tracked on
21our public [project board](https://github.com/aws/aws-cdk/projects/2).
23If you want to contribute a specific feature or fix you have in mind, check our
24[in-flight work](https://github.com/aws/aws-cdk/projects/2#column-8268897) or
25[open pull requests](https://github.com/aws/aws-cdk/projects/2#column-11918985)
26to see if someone else is already working on it. If an issue has someone
27assigned to it in our "In Progress" column, that means they are actively
28working on it. Otherwise, any unassigned issue is up for grabs!
30If an issue doesn't exist for your feature/fix, please create one using the
31appropriate [issue
34If you're simply looking for any issue to work on, explore our [Backlog of
35issues](https://github.com/aws/aws-cdk/projects/2#column-8114389) on the public
36project board and find something that piques your interest. If you are looking
37for your first contribution, the ['good first issue'
39will be of help.
41### Let us know what you're working on!
42Once you've chosen to work on an existing issue, please **add a comment to
43indicate that you are starting work on it!** This will help us assign the
44issue to you and keep track of issues being actively worked on, to avoid
45duplicate effort.
47### Include a design if you can!
48For larger features, your contribution is far more likely to be accepted if you:
491. let us know you are working on it!
502. include a design document.
52Examples of past designs for the ECS module can be found in under the
53[design](https://github.com/aws/aws-cdk/tree/master/design/aws-ecs) directory.
55## Breaking Changes
56See guidance on breaking changes in the [Contributing Guide](https://github.com/aws/aws-cdk/blob/master/CONTRIBUTING.md#breaking-changes).