-
Notifications
You must be signed in to change notification settings - Fork 429
docs(roadmap): add new roadmap section #1204
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
heitorlessa
merged 7 commits into
aws-powertools:develop
from
heitorlessa:docs/new-roadmap
May 17, 2022
Merged
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
8f2a58f
docs(roadmap): add new roadmap section
heitorlessa b92bd44
docs(roadmap): add disclaimer section
heitorlessa bc65f27
docs(roadmap): add visual representation
heitorlessa 644a858
docs(roadmap): add note for non-new features
heitorlessa 36d5d18
docs(home): update roadmap link
heitorlessa d171f1a
docs(roadmap): change toc order
heitorlessa beb2934
docs: moved security disclosure to main readme
heitorlessa File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,103 @@ | ||
## Overview | ||
|
||
???+ info "We are currently paused for new features [until end of July 2022](https://github.com/awslabs/aws-lambda-powertools-python/issues/1009){target="_blank"}." | ||
|
||
This is our public roadmap that outlines the high level direction we are working towards, namely [Themes](#themes). We update this document on a periodic basis to reflect any changing priorities - Security and stability is our top priority. | ||
|
||
[See our latest list of activities »](https://github.com/orgs/awslabs/projects/51/views/1?query=is%3Aopen+sort%3Aupdated-desc){target="_blank"} | ||
|
||
## Roadmap status definition | ||
|
||
<center> | ||
```mermaid | ||
graph LR | ||
Ideas --> Backlog --> Work["Working on it"] --> Merged["Coming soon"] --> Shipped | ||
``` | ||
<i>Visual representation</i> | ||
</center> | ||
|
||
Within our [public board](https://github.com/orgs/awslabs/projects/51/views/1?query=is%3Aopen+sort%3Aupdated-desc){target="_blank"}, you'll see the following values in the `Status` column: | ||
|
||
* **Ideas**. Incoming and existing feature requests that are not being actively considered yet. These will be reviewed when bandwidth permits. | ||
* **Backlog**. Accepted feature requests or enhancements that we want to work on. | ||
* **Working on it**. Features or enhancements we're currently either researching or implementing it. | ||
* **Coming soon**. Any feature, enhancement, or bug fixes that have been merged and are coming in the next release. | ||
* **Shipped**. Features or enhancements that are now available in the most recent release. | ||
|
||
> Tasks or issues with empty `Status` will be categorized in upcoming review cycles. | ||
|
||
## Process | ||
|
||
<center> | ||
```mermaid | ||
graph LR | ||
PFR[Feature request] --> Triage{Need RFC?} | ||
Triage --> |Complex/major change or new utility?| RFC[Ask or write RFC] --> Approval{Approved?} | ||
Triage --> |Minor feature or enhancement?| NoRFC[No RFC required] --> Approval | ||
Approval --> |Yes| Backlog | ||
Approval --> |No | Reject["Inform next steps"] | ||
Backlog --> |Prioritized| Implementation | ||
Backlog --> |Defer| WelcomeContributions["help-wanted label"] | ||
``` | ||
<i>Visual representation</i> | ||
</center> | ||
|
||
Our end-to-end mechanism follows four major steps: | ||
|
||
* **Feature Request**. Ideas start with a [feature request issue template](https://github.com/awslabs/aws-lambda-powertools-python/issues/new?assignees=&labels=feature-request%2Ctriage&template=feature_request.yml&title=Feature+request%3A+TITLE){target="_blank"} to highlight their use case at a high level. Maintainers review each request based on the **(1)** [project tenets](index.md#tenets){target="_blank"}, **(2)** customers reaction (👍) and use cases, and comment whether we'll need a RFC for further discussion before any work begins. | ||
* **Request-for-comments (RFC)**. Design proposals use our [RFC issue template](https://github.com/awslabs/aws-lambda-powertools-python/issues/new?assignees=&labels=RFC%2Ctriage&template=rfc.yml&title=RFC%3A+TITLE){target="_blank"} to describe its implementation, challenges, developer experience, dependencies, and alternative solutions. This helps refine the initial idea with community feedback before a decision is made. | ||
* **Decision**. After carefully reviewing and discussing them, maintainers make a final decision on whether to start implementation, defer or reject it, and update everyone with the next steps. | ||
* **Implementation**. For approved features, maintainers will build a prototype and invite customers for feedback in the original request. Alternatively, maintainers will proactively use the [help wanted](https://github.com/awslabs/aws-lambda-powertools-python/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22help+wanted%22){target="_blank"} tag to signal contributions are welcome to accelerate development. | ||
* **Implementation**. For approved features, maintainers will build a prototype for early feedback, or use [`help wanted`](https://github.com/awslabs/aws-lambda-powertools-python/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22help+wanted%22){target="_blank"} label welcoming contributions to accelerate development. | ||
|
||
???+ info "Bug reports, documentation improvements, etc. are not covered by this process. See Maintainers process instead (coming soon)." | ||
|
||
## Themes | ||
|
||
Themes are key activities maintainers are focusing on, besides bug reports. These are updated periodically and you can find the latest [under Epics in our public board](https://github.com/orgs/awslabs/projects/51/views/11?query=is%3Aopen+sort%3Aupdated-desc){target="_blank"}. | ||
|
||
### Lambda Layers migration | ||
|
||
We are migrating our Lambda Layers internal release pipeline towards an AWS CodePipeline based system. This will allow us to more rapidly adopt additional regions, custom builds, and decrease our rollout time to all commercial regions. | ||
|
||
### End-to-end testing | ||
|
||
We are working on a framework to selectively run end-to-end tests as part of Pull Requests and upon merge. This will increase our confidence in detecting regressions early, and also explore ideas for utilities that can make testing easier for customers. | ||
|
||
### Python 3.6 deprecation | ||
|
||
We will remove support for Python 3.6 after July 18th, following AWS Lambda [deprecation notice for Python 3.6 runtime](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-support-policy){target="_blank"}. We will monitor the deprecation notice in the event of any extension. | ||
|
||
### Reduce release operational overhead | ||
|
||
We are working on a consistent label and automation strategy across all Lambda Powertools projects ([Java](https://awslabs.github.io/aws-lambda-powertools-java/){target="_blank"}, [TypeScript](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/){target="_blank"}). This will be our baseline to automate areas where we don't need human intervention, and reduce our manual effort to areas where clear communication is crucial. | ||
|
||
### Revamp roadmap | ||
|
||
We are beta testing the [new GitHub Projects Beta](https://github.com/orgs/awslabs/projects/51/views/1?query=is%3Aopen+sort%3Aupdated-desc){target="_blank"} to provide more visibility on our current activities. This also includes new GitHub Issue Forms Beta to streamline feature requests, bug reports, RFCs, etc., including a new mechanism to add external links like `Ask a Question`. | ||
|
||
Once complete, we will repurpose our [central roadmap repository](https://github.com/awslabs/aws-lambda-powertools-roadmap){target="_blank"} to provide a landing page for all Powertools languages, including an experiment to better highlight feature parity across them. | ||
|
||
|
||
## Disclaimer | ||
|
||
The AWS Lambda Powertools team values feedback and guidance from its community of users, although final decisions on inclusion into the project will be made by AWS. We determine the high-level direction for our open roadmap based on customer feedback and popularity (👍🏽 and comments), security and operational impacts, and business value. Where features don’t meet our goals and longer-term strategy, we will communicate that clearly and openly as quickly as possible with an explanation of why the decision was made. | ||
|
||
## Security disclosures | ||
|
||
If you think you’ve found a potential security issue, please do not post it in the Issues. Instead, please follow the instructions [here](https://aws.amazon.com/security/vulnerability-reporting/) or [email AWS security directly](mailto:aws-security@amazon.com). | ||
|
||
|
||
## FAQs | ||
|
||
**Q: Why did you build this?** | ||
|
||
A: We know that our customers are making decisions and plans based on what we are developing, and we want to provide our customers the insights they need to plan. | ||
|
||
**Q: Why are there no dates on your roadmap?** | ||
|
||
A: Because job zero is security and operational stability, we can't provide specific target dates for features. The roadmap is subject to change at any time, and roadmap issues in this repository do not guarantee a feature will be launched as proposed. | ||
|
||
**Q: How can I provide feedback or ask for more information?** | ||
|
||
A: For existing features, you can directly comment on issues. For anything else, please open an issue. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.