Skip to content

Commit 0d352b1

Browse files
kaiz-ioMichael Kaiserericzbeard
authored
Fix:Language Parity Stance and Links (#932)
Co-authored-by: Michael Kaiser <[email protected]> Co-authored-by: Eric Z. Beard <[email protected]>
1 parent 0bef64c commit 0d352b1

File tree

2 files changed

+7
-17
lines changed

2 files changed

+7
-17
lines changed

CONTRIBUTING.md

+4-15
Original file line numberDiff line numberDiff line change
@@ -9,21 +9,19 @@ information to effectively respond to your bug report or contribution.
99
## Table of Contents
1010
1. [Reporting Bugs/Feature Requests](#Reporting)
1111
2. [Contributing via Pull Requests](#Pulls)
12-
3. [Adding an Example](#New)
1312
4. [Linking External Example](#Extern)
1413
5. [Style and Formatting](#Style)
1514
6. [Finding Contributions to Work On](#Finding)
1615
7. [Adding Learning Resources](#Resources)
17-
8. [Code of Conduct](CoC)
16+
8. [Code of Conduct](#CoC)
1817
9. [Security Issue Notifications](#Security)
1918
10. [Licensing](#License)
2019

2120
## Reporting Bugs/Feature Requests <a name="Reporting"></a>
2221

2322
We welcome you to use the GitHub issue tracker to report bugs or suggest features.
2423

25-
When filing an issue, please check [existing open](https://github.com/aws-samples/aws-cdk-examples/issues), or [recently closed](https://github.com/aws-samples/aws-cdk-examples/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), issues to make sure somebody else hasn't already
26-
reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
24+
When filing an issue, please check [existing open](https://github.com/aws-samples/aws-cdk-examples/issues), or [recently closed](https://github.com/aws-samples/aws-cdk-examples/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), issues to make sure somebody else hasn't already reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
2725

2826
* A reproducible test case or series of steps
2927
* The version of our code being used
@@ -35,12 +33,12 @@ Contributions via pull requests are much appreciated. Before sending us a pull r
3533

3634
1. You are working against the latest source on the *master* branch.
3735
2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
38-
3. You open an issue to discuss any significant work - we would hate for your time to be wasted.
3936

4037
To send us a pull request, please:
4138

4239
1. Fork the repository.
4340
2. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change.
41+
4. Ensure your example passes `cdk synth` or indicate in the PR why it does not.
4442
3. Ensure local tests pass automated tests (check the [scripts](https://github.com/aws-samples/aws-cdk-examples/tree/master/scripts) directory)
4543
4. Commit to your fork using clear commit messages.
4644
5. Send us a pull request, answering any default questions in the pull request interface.
@@ -49,10 +47,6 @@ To send us a pull request, please:
4947
GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
5048
[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
5149

52-
## Adding an Example <a name="New"></a>
53-
54-
When adding a new example, there are several things important to consider as you implement (please create a [`feature-request` issue](https://github.com/aws-samples/aws-cdk-examples/issues/new?labels=feature-request%2C+needs-triage&template=feature-request.md) to discuss these before writing your contribution):
55-
5650
### Added Value
5751
As an official learning resource, it is important that any new examples add value to our learning resources. This means that it should not duplicate an existing example, and cover one of the following topics:
5852

@@ -62,11 +56,6 @@ As an official learning resource, it is important that any new examples add valu
6256

6357
When we are considering merging a new contribution we will review the above criteria as well as evaluating quality based on the criteria in the following sections.
6458

65-
### Language Parity
66-
While we have historically allowed adding examples in just one of our supported languages, moving forward we would like to maintain language parity. This does not necessarily mean that you must write the example in each language yourself, but a PR will not be merged until the example has been added for each language.
67-
68-
If you are looking for help to achieve language parity, you can request help in either the issue related to the new example, or directly through the PR.
69-
7059
### Components
7160

7261
When adding a new example, there are several required components. The majority of these will be added when running `cdk init`.
@@ -143,7 +132,7 @@ Looking at the existing issues is a great way to find something to contribute on
143132
## Adding Learning Resources <a name="Resources"></a>
144133
On the main README of this repo, we maintain a shortlist of additional learning resources related to the CDK. The "Officially Supported" section will be maintained by CDK project maintainers, however if you have a resource (workshop, example-set, etc.) you think should be added to the list, create a PR with your reasoning for adding in the description and a CDK maintainer will discuss with you in PR reviews.
145134

146-
When adding a resource (or external example), please make the same considerations you would for [adding a new example](#New).
135+
When adding a resource (or external example), please make the same considerations you would for [adding a new example](#Pulls).
147136

148137
## Code of Conduct <a name="CoC"></a>
149138
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).

README.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# AWS CDK Examples
22

33
This repository contains a set of example projects for the [AWS Cloud Development
4-
Kit](https://github.com/awslabs/aws-cdk).
4+
Kit](https://github.com/aws/aws-cdk).
55

66
## Table of Contents
77
1. [About this Repo](#About)
@@ -35,8 +35,9 @@ While this is an excellent learning resource for the CDK, there are other resour
3535
### Official Resources
3636
- [Developer Guide](https://docs.aws.amazon.com/cdk/latest/guide/home.html)
3737
- [API Reference](https://docs.aws.amazon.com/cdk/api/latest/docs/aws-construct-library.html)
38-
- [CDK Workshop](https://cdkworkshop.com/)
3938
- [CDK Repository](https://github.com/aws/aws-cdk)
39+
- [CDK Construct Hub](https://constructs.dev/)
40+
- [CDK Workshop](https://cdkworkshop.com/)
4041

4142
### Unofficial/Community Resources
4243
- [AwesomeCDK](https://github.com/kolomied/awesome-cdk)

0 commit comments

Comments
 (0)