You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We welcome you to use the GitHub issue tracker to report bugs or suggest features.
24
23
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:
27
25
28
26
* A reproducible test case or series of steps
29
27
* The version of our code being used
@@ -35,12 +33,12 @@ Contributions via pull requests are much appreciated. Before sending us a pull r
35
33
36
34
1. You are working against the latest source on the *master* branch.
37
35
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.
39
36
40
37
To send us a pull request, please:
41
38
42
39
1. Fork the repository.
43
40
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.
44
42
3. Ensure local tests pass automated tests (check the [scripts](https://github.com/aws-samples/aws-cdk-examples/tree/master/scripts) directory)
45
43
4. Commit to your fork using clear commit messages.
46
44
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:
49
47
GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
50
48
[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
51
49
52
-
## Adding an Example <aname="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
-
56
50
### Added Value
57
51
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:
58
52
@@ -62,11 +56,6 @@ As an official learning resource, it is important that any new examples add valu
62
56
63
57
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.
64
58
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
-
70
59
### Components
71
60
72
61
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
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.
145
134
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).
147
136
148
137
## Code of Conduct <aname="CoC"></a>
149
138
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
0 commit comments