Skip to content

Commit db111af

Browse files
authoredMar 5, 2020
docs(TRACKING): update tracking issue template (aws#6606)
* add ROADMAP.md and update README.md to link to ROADMAP * fix some errant spaces * Added module maturity section and moved the API reference link to the Implementation section
1 parent 79f70c9 commit db111af

File tree

3 files changed

+103
-2
lines changed

3 files changed

+103
-2
lines changed
 

‎.github/ISSUE_TEMPLATE/tracking.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,13 @@ service’s CDK Construct Library API reference page.
2121

2222

2323
[AWS Docs](url) <!-- replace `url` with link to the relevant AWS Docs -->
24-
[CDK API Reference](url) <!-- replace `url` with link to the service's CDK API reference -->
24+
25+
### Maturity: CloudFormation Resources Only
26+
<!--
27+
The valid maturity states are: CloudFormation Resources Only, Experimental, Developer Preview, Stable
28+
-->
29+
30+
See the [AWS Construct Library Module Lifecycle doc](https://github.com/aws/aws-cdk-rfcs/blob/master/text/0107-construct-library-module-lifecycle.md) for more information about maturity levels.
2531

2632

2733
### Implementation:
@@ -31,6 +37,7 @@ Checklist of use cases, constructs, features (such as grant methods) that will s
3137
- [ ]
3238
- [ ]
3339
-->
40+
[CDK API Reference](url) <!-- replace `url` with link to the service's CDK API reference -->
3441

3542

3643

‎README.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,8 @@ The CDK is available in the following languages:
3030
[API Reference](https://docs.aws.amazon.com/cdk/api/latest/docs/aws-construct-library.html) |
3131
[Examples](https://github.com/aws-samples/aws-cdk-examples) |
3232
[Getting Help](#getting-help) |
33-
[RFCs](https://github.com/aws/aws-cdk-rfcs)
33+
[RFCs](https://github.com/aws/aws-cdk-rfcs) |
34+
[Roadmap](https://github.com/aws/aws-cdk/ROADMAP.md)
3435

3536
Developers use the [CDK framework] in one of the
3637
supported programming languages to define reusable cloud components called [constructs], which
@@ -122,6 +123,13 @@ We welcome community contributions and pull requests. See
122123
[CONTRIBUTING](./CONTRIBUTING.md) for information on how to set up a development
123124
environment and submit code.
124125

126+
## Roadmap
127+
128+
The [AWS CDK Roadmap project board] lets developers know about our upcoming features and priorities to help them plan how to best leverage the CDK and identify opportunities to contribute to the project. See [ROADMAP] for more information and FAQs.
129+
130+
[AWS CDK Roadmap project board]: https://github.com/orgs/aws/projects/7
131+
[Roadmap]: (https://github.com/aws/aws-cdk/ROADMAP.md)
132+
125133
## License
126134

127135
The AWS CDK is distributed under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0).

‎ROADMAP.md

+86
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
# AWS CDK Roadmap
2+
3+
The [AWS CDK Roadmap] lets developers know about our upcoming features and priorities to help them plan how to best leverage the CDK and identify opportunities to contribute to the project. The roadmap provides a high-level view of our work in progress across the [aws-cdk], [aws-cdk-rfcs], and [jsii] repositories, and creates an opportunity for customers to engage in a conversation with AWS CDK engineers to give us direct feedback.
4+
5+
[AWS CDK Roadmap]: https://github.com/orgs/aws/projects/7
6+
[aws-cdk]: https://github.com/aws/aws-cdk
7+
[aws-cdk-rfcs]: https://github.com/aws/aws-cdk-rfcs
8+
[jsii]: https://github.com/aws/jsii
9+
10+
## Roadmap FAQs
11+
12+
**Q: How do you manage the roadmap?**
13+
14+
A: We know that our customers are making decisions and plans based on what we
15+
are developing, and we want to provide the information they need to be successful. Our roadmap management tenets are:
16+
17+
* **Be transparent** with customers about the AWS CDK team’s work in progress
18+
* **Listen to customers,** allowing them to participate in design decisions and to vote on and propose new AWS CDK
19+
features. We will periodically re-prioritize the roadmap based on customer feedback
20+
* **Stay up-to-date,** or we will lose customer trust
21+
* **Provide the right level of detail** so customers can easily see what we’re working on at a glance, without being
22+
overwhelmed by minutiae
23+
* **Guide the community** on what AWS CDK constructs or features to contribute without the risk of conflicting with work
24+
already in progress
25+
26+
**Q: What do the roadmap project board columns mean?**
27+
28+
A: There are four columns on the roadmap project board:
29+
30+
* **Researching** - We’re thinking about it, but cannot commit if, or when, we will work on items in this list.
31+
This means we are still designing the feature and evaluating how it might work. This is the phase when we collect
32+
customer use cases and feedback on how they want to see something implemented. There is no firm commitment to deliver
33+
functionality listed in the Researching column, and there might be situations that require us to move items from the
34+
roadmap back to the backlog.
35+
* **We’re working on it** - In progress, but further out. We have made an implied commitment to work on items in this
36+
bucket, they have some level of design spec’ed out, and a developer assigned to them. Items might linger in this
37+
bucket as we work through the implementation details, or scope stuff out. Think several months out until a developer
38+
preview release, give or take.
39+
* **Developer preview** - It’s available now as a release candidate. Items will spend extended periods of time in
40+
developer preview as we conduct user acceptance testing and accumulate sufficient usage to declare the API stable and
41+
ready for general availability. We will only make breaking changes to developer preview modules when we need to address unforeseen use cases or issues. Not all
42+
features, such as enhancements to the CDK CLI, will have a developer preview phase. In these cases the tracking issue
43+
is moved directly to the Shipped bucket when released.
44+
* **Shipped** - It’s available now, fully supported by AWS, and we guarantee the API is stable and safe to use in
45+
production.
46+
47+
**Q: How do items on the roadmap move across the project board?**
48+
49+
A: The [AWS Construct Library module lifecycle
50+
document](https://github.com/aws/aws-cdk-rfcs/blob/master/text/0107-construct-library-module-lifecycle.md) describes how
51+
we graduate packages from experimental, to developer preview, to generally available.
52+
53+
**Q: Why are there no dates on this roadmap?**
54+
55+
A: Security and operational stability are our main priority and we will not ship a feature until these criteria are met,
56+
therefore we generally don’t provide specific target dates for releases.
57+
58+
**Q: Is every feature on the roadmap?**
59+
60+
A: The AWS Cloud Development Kit roadmap provides transparency on our priority for adding new programming languages,
61+
developer experience improvements, and service coverage in the AWS Construct Library. The AWS CDK toolkit and AWS
62+
Construct Library are such a large surface areas we are intentionally keeping the roadmap at a high-level, so not every
63+
CDK feature request will appear on the roadmap. Instead, the roadmap will include a tracking issue
64+
for each deliverable that provides a feature overview and contains links to relevant, more granular issues and pull
65+
requests. If you want to track the status of a specific issue or pull request, you can do so by monitoring that work
66+
item in the [aws-cdk] GitHub repository.
67+
68+
**Q: What is a tracking issue?**
69+
70+
A: We create a tracking issue for each CDK feature, AWS Construct Library module, and jsii-supported programming language. Tracking issues provide a brief summary of the feature and a consolidated view of the work scoped for the release. They include links to design documentation, implementation details, and relevant issues. Tracking issues are living documents that start from a basic template and grow more robust over time as we experiment and learn. You can easily find tracking issues by filtering on the [management/tracking label](https://github.com/aws/aws-cdk/labels/management%2Ftracking).
71+
72+
**Q: How can I provide feedback on the roadmap or ask for more information about a feature?**
73+
74+
A: Please open an issue!
75+
76+
**Q: How can I request a feature be added to the roadmap?**
77+
78+
A: Please open an issue! Community submitted issues will be tagged “feature-request” and will be reviewed by the team.
79+
80+
**Q: Can I “+1” tracking issues and feature requests?**
81+
82+
A: We strongly encourage you to do so, as it helps us understand which issues will have the broadest impact. You can navigate to the issue details page and add a reaction. There are six types of reactions (thumbs up “+1”, thumbs down “-1”, confused, heart, watching, laugh, and hooray) you can use to help us decide which items will benefit you most.
83+
84+
**Q: Will you accept a pull request to the aws-cdk repo?**
85+
86+
A: Yes! We take PRs very seriously and will review for inclusion. You can read how to contribute to the CDK [here](https://github.com/aws/aws-cdk/blob/master/CONTRIBUTING.md).

0 commit comments

Comments
 (0)
Please sign in to comment.