Skip to content

Commit ca2af73

Browse files
authored
Merge pull request #291 from aws-powertools/doc-updates-roadmap
docs: Update roadmap and maintainers
2 parents 95d604e + 9e4c439 commit ca2af73

File tree

6 files changed

+101
-18
lines changed

6 files changed

+101
-18
lines changed

.github/CODEOWNERS

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
2+
3+
* @awslabs/aws-lambda-powertools-net

.github/auto_assign.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
addReviewers: true
33

44
# Set to true to add assignees to pull requests
5-
addAssignees: true
5+
#addAssignees: true
66

77
# A list of reviewers to be added to pull requests (GitHub user name)
88
reviewers:
@@ -12,7 +12,7 @@ reviewers:
1212

1313
# A number of reviewers added to the pull request
1414
# Set 0 to add all the reviewers (default: 0)
15-
numberOfReviewers: 1
15+
numberOfReviewers: 0
1616

1717

1818
# A number of assignees to add to the pull request

.github/boring-cyborg.yml

+30-9
Original file line numberDiff line numberDiff line change
@@ -3,27 +3,43 @@ labelPRBasedOnFilePath:
33
area/common:
44
- libraries/src/AWS.Lambda.Powertools.Common/*
55
- libraries/src/AWS.Lambda.Powertools.Common/**/*
6-
area/logger:
6+
area/logging:
77
- libraries/src/AWS.Lambda.Powertools.Logging/*
88
- libraries/src/AWS.Lambda.Powertools.Logging/**/*
9-
area/tracer:
10-
- libraries/src/AWS.Lambda.Powertools.Tracing/*
11-
- libraries/src/AWS.Lambda.Powertools.Tracing/**/*
12-
area/metrics:
13-
- libraries/src/AWS.Lambda.Powertools.Metrics/*
14-
- libraries/src/AWS.Lambda.Powertools.Metrics/**/*
15-
area/tracer:
9+
area/tracing:
1610
- libraries/src/AWS.Lambda.Powertools.Tracing/*
1711
- libraries/src/AWS.Lambda.Powertools.Tracing/**/*
1812
area/metrics:
1913
- libraries/src/AWS.Lambda.Powertools.Metrics/*
2014
- libraries/src/AWS.Lambda.Powertools.Metrics/**/*
15+
area/parameters:
16+
- libraries/src/AWS.Lambda.Powertools.Parameters/*
17+
- libraries/src/AWS.Lambda.Powertools.Parameters/**/*
18+
area/Idempotency:
19+
- libraries/src/AWS.Lambda.Powertools.Idempotency/*
20+
- libraries/src/AWS.Lambda.Powertools.Idempotency/**/*
2121

2222
documentation:
2323
- docs/*
2424
- docs/**/*
2525
- mkdocs.yml
2626

27+
github-actions:
28+
- .github/workflows/*
29+
- .github/workflows/**/*
30+
- .github/dependabot.yml
31+
- .github/boring-cyborg.yml
32+
- .github/release-drafter.yml
33+
- .github/semantic.yml
34+
- .github/stale.yml
35+
- .github/mergify.yml
36+
37+
github-templates:
38+
- .github/ISSUE_TEMPLATE/*
39+
- .github/PULL_REQUEST_TEMPLATE.md
40+
- .github/.chglog/*
41+
- .github/.chglog/**/*
42+
2743
internal:
2844
- .github/*
2945
- .github/**/*
@@ -35,6 +51,7 @@ labelPRBasedOnFilePath:
3551
- CONTRIBUTING.md
3652
- CODE_OF_CONDUCT.md
3753
- LICENSE
54+
- MAINTAINERS.md
3855

3956
tests:
4057
- libraries/tests/*
@@ -45,10 +62,14 @@ labelPRBasedOnFilePath:
4562
firstPRWelcomeComment: >
4663
Thanks a lot for your first contribution! Please check out our contributing guidelines and don't hesitate to ask whatever you need.
4764
65+
In the meantime, check out the #python channel on our Powertools for AWS Lambda Discord: [Invite link](https://discord.gg/B8zZKbbyET)
66+
4867
# Comment to be posted to congratulate user on their first merged PR
4968
firstPRMergeComment: >
5069
Awesome work, congrats on your first merged pull request and thank you for helping improve everyone's experience!
5170
5271
# Comment to be posted to on first time issues
5372
firstIssueWelcomeComment: >
54-
Thanks for opening your first issue here! We'll come back to you as soon as we can.
73+
Thanks for opening your first issue here! We'll come back to you as soon as we can.
74+
75+
In the meantime, check out the #python channel on our Powertools for AWS Lambda Discord: [Invite link](https://discord.gg/B8zZKbbyET)

.github/release-drafter.yml

+5-2
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,17 @@ categories:
2424
labels:
2525
- 'internal'
2626
- 'dependencies'
27+
- 'chore'
2728
exclude-labels:
2829
- 'skip-changelog'
29-
tag-template: 'v$NEXT_PATCH_VERSION'
30+
tag-template: '$NEXT_PATCH_VERSION'
3031
template: |
31-
## Changes
32+
## Summary
3233
3334
**[Human readable summary of changes]**
3435
36+
## Changes
37+
3538
$CHANGES
3639
3740
## This release was made possible by the following contributors:

MAINTAINERS.md

+1
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ This is document explains who the maintainers are (see below), what they do in t
4343
| ----------------- | --------------------------------------------- | ----------- |
4444
| Stephen Liedig | [sliedig](https://github.com/sliedig) | Amazon |
4545
| Amir Khairalomoum | [amirkaws](https://github.com/amirkaws) | Amazon |
46+
| Henrique Graca | [hjgraca](https://github.com/hjgraca) | Amazon |
4647

4748
## Emeritus
4849

docs/roadmap.md

+60-5
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,72 @@
22

33
This is our public roadmap that outlines the high level direction we are working towards, namely [Themes](#themes). We update this document when our priorities change: security and stability is our top priority.
44

5-
[See our latest list of activities »](https://github.com/orgs/awslabs/projects/56/views/1?query=is%3Aopen+sort%3Aupdated-desc){target="_blank"}
5+
[See our latest list of activities »](https://github.com/orgs/awslabs/projects/105/views/4?query=is%3Aopen+sort%3Aupdated-desc){target="_blank"}
66

77
## Themes
88

9-
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"}.
9+
!!! info "Operational Excellence is priority number 1."
1010

11-
### Revamp roadmap
11+
Themes are key activities maintainers are focusing on, besides bug reports. These are updated periodically and you can get an idea of the overall progress in the [Milestones section](https://github.com/awslabs/aws-lambda-powertools-dotnet/milestones){target="_blank"}.
1212

13-
We are beta testing the [new GitHub Projects Beta](https://github.com/orgs/awslabs/projects/56/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`.
13+
### New utilities
1414

15-
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 for AWS Lambda languages, including an experiment to better highlight feature parity across them.
15+
After going GA, we want to start working on new utilities, specifically but not limited to the most commonly asked: **(1)** [Idempotency](https://github.com/awslabs/aws-lambda-powertools-dotnet/issues/164), **(2)** [Parameters](https://github.com/awslabs/aws-lambda-powertools-dotnet/issues/160) and **(3)** [Batch](https://github.com/awslabs/aws-lambda-powertools-dotnet/issues/168).
16+
17+
### Improve operational excellence
18+
19+
We continue to work on increasing operational excellence to remove as much undifferentiated heavylifting for maintainers, so that we can focus on delivering features that help you.
20+
21+
This means improving our automation workflows, and project management, and test coverage.
22+
23+
## Roadmap status definition
24+
25+
<center>
26+
```mermaid
27+
graph LR
28+
Ideas --> Backlog --> Work["Working on it"] --> Merged["Coming soon"] --> Shipped
29+
```
30+
<i>Visual representation</i>
31+
</center>
32+
33+
Within our [public board](https://github.com/orgs/awslabs/projects/105/views/3?query=is%3Aopen+sort%3Aupdated-desc){target="_blank"}, you'll see the following values in the `Status` column:
34+
35+
* **Ideas**. Incoming and existing feature requests that are not being actively considered yet. These will be reviewed when bandwidth permits and based on demand.
36+
* **Backlog**. Accepted feature requests or enhancements that we want to work on.
37+
* **Working on it**. Features or enhancements we're currently either researching or implementing it.
38+
* **Coming soon**. Any feature, enhancement, or bug fixes that have been merged and are coming in the next release.
39+
* **Shipped**. Features or enhancements that are now available in the most recent release.
40+
* **On hold**. Features or items that are currently blocked until further notice.
41+
* **Pending review**. Features which implementation is mostly completed, but need review and some additional iterations.
42+
43+
> Tasks or issues with empty `Status` will be categorized in upcoming review cycles.
44+
45+
## Process
46+
47+
<center>
48+
```mermaid
49+
graph LR
50+
PFR[Feature request] --> Triage{Need RFC?}
51+
Triage --> |Complex/major change or new utility?| RFC[Ask or write RFC] --> Approval{Approved?}
52+
Triage --> |Minor feature or enhancement?| NoRFC[No RFC required] --> Approval
53+
Approval --> |Yes| Backlog
54+
Approval --> |No | Reject["Inform next steps"]
55+
Backlog --> |Prioritized| Implementation
56+
Backlog --> |Defer| WelcomeContributions["help-wanted label"]
57+
```
58+
<i>Visual representation</i>
59+
</center>
60+
61+
Our end-to-end mechanism follows four major steps:
62+
63+
* **Feature Request**. Ideas start with a [feature request](https://github.com/awslabs/aws-lambda-powertools-dotnet/issues/new?assignees=&labels=feature-request%2Ctriage&projects=&template=feature_request.yml&title=Feature+request%3A+TITLE){target="_blank"} to outline their use case at a high level. For complex use cases, maintainers might ask for/write a RFC.
64+
* Maintainers review requests based on [project tenets](index.md#tenets){target="_blank"}, customers reaction (👍), and use cases.
65+
* **Request-for-comments (RFC)**. Design proposals use our [RFC issue template](https://github.com/awslabs/aws-lambda-powertools-dotnet/issues/new?assignees=&labels=RFC%2Ctriage&projects=&template=rfc.yml&title=RFC%3A+TITLE){target="_blank"} to describe its implementation, challenges, developer experience, dependencies, and alternative solutions.
66+
* This helps refine the initial idea with community feedback before a decision is made.
67+
* **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.
68+
* **Implementation**. For approved features, maintainers give priority to the original authors for implementation unless it is a sensitive task that is best handled by maintainers.
69+
70+
??? info "See [Maintainers](https://github.com/awslabs/aws-lambda-powertools-dotnet/blob/develop/MAINTAINERS.md) document to understand how we triage issues and pull requests, labels and governance."
1671

1772
## Disclaimer
1873

0 commit comments

Comments
 (0)