Skip to content

Commit e210bbd

Browse files
saragerionsaragerion
authored
improv: repository documentation, metadata, github actions, dot files (aws-powertools#17)
* build(all): add codeowners, issue templates, workflows, remove gradle * chore(all): edit dot files, polish docs about contribuiting and security * chore: format comments, polishing of github templates
1 parent aa211d1 commit e210bbd

30 files changed

+7321
-21316
lines changed

Diff for: ‎.eslintignore

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
coverage
2+
lib
3+
node_modules
4+
tests/resources/*

Diff for: ‎.eslintrc.js

-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ module.exports = {
99
'plugin:@typescript-eslint/eslint-recommended',
1010
'plugin:@typescript-eslint/recommended'
1111
],
12-
ignorePatterns: ['tests/resources/*'],
1312
parser: '@typescript-eslint/parser',
1413
plugins: ['@typescript-eslint'],
1514
rules: {

Diff for: ‎.github/CODEOWNERS

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# These owners will be the default owners for everything in
2+
# the repo.
3+
# TODO: revisit this list
4+
* @saragerion, @alan-churley, @heitorlessa

Diff for: ‎.github/ISSUE_TEMPLATE/BUG_REPORT.md

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: "(module name): short issue description"
5+
labels: bug, triage
6+
assignees: saragerion, alan-churley
7+
8+
---
9+
10+
<!--- Before you start, make sure that the bug hasn't been reported already https://github.com/awslabs/aws-lambda-powertools-typescript/issues -->
11+
<!--- 1. Make sure you follow our Contributing Guidelines: https://github.com/awslabs/aws-lambda-powertools-typescript/blob/main/CONTRIBUTING.md -->
12+
<!--- 2. Please follow the template, and do not remove any section in the template. If something is not applicable leave it empty, but leave it in the issue. -->
13+
<!--- 3. Provide a general summary of the issue in the Title above -->
14+
15+
## Bug description
16+
17+
<!--- Provide a summary of the bug here. -->
18+
19+
<!--- What were you trying to accomplish? -->
20+
21+
### Expected Behavior
22+
23+
<!--- Tell us what should happen. -->
24+
25+
### Current Behavior
26+
27+
<!--- Tell us what happens instead of the expected behavior. -->
28+
29+
### Possible Solution
30+
31+
<!--- Not obligatory, but suggest a fix/solutions/implementation for the bug. -->
32+
33+
### Steps to Reproduce
34+
35+
<!--- Provide a link to a live example, or an unambiguous set of steps to -->
36+
<!--- reproduce this bug. Include code to reproduce, if relevant. -->
37+
1.
38+
2.
39+
3.
40+
4.
41+
42+
### Environment
43+
44+
* **Powertools version used**:
45+
* **Packaging format (Layers, npm)**:
46+
* **AWS Lambda function runtime:**
47+
* **Debugging logs:**
48+
49+
### Related issues, RFCs
50+
51+
<!--- Add here the link to one or more Github Issues or RFCs that are related to this PR. -->
52+
<!--- [#XXXXX](https://github.com/awslabs/aws-lambda-powertools-typescript/issues/XXXXX) -->
53+
<!--- [#ZZZZZ](https://github.com/awslabs/aws-lambda-powertools-typescript/issues/ZZZZZ) -->

Diff for: ‎.github/ISSUE_TEMPLATE/DOC_IMPROVEMENT.md

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
name: Documentation improvement
3+
about: Suggest a documentation update, improvement
4+
title: "(module name): short issue description"
5+
labels: documentation
6+
assignees: saragerion, alan-churley
7+
8+
---
9+
10+
<!--- 1. Make sure you follow our Contributing Guidelines: https://github.com/awslabs/aws-lambda-powertools-typescript/blob/main/CONTRIBUTING.md -->
11+
<!--- 2. Please follow the template, and do not remove any section in the template. If something is not applicable leave it empty, but leave it in the issue. -->
12+
13+
## Description of the improvement
14+
15+
**Summary of the proposal**
16+
<!--- Include here a summary of the proposal, including relevant motivation and context. -->
17+
18+
**How, where did you look for information**
19+
<!--- Help us understand how you looked for information that was either not available or unclear. -->
20+
21+
**Missing or unclear documentation**
22+
<!--- What were you initially looking for in the docs? -->
23+
24+
**Improvement**
25+
<!--- Describe how we could make it clearer. -->
26+
<!--- Feel free to add specific examples. -->
27+
28+
### Related existing documentation
29+
30+
<!--- Is your suggestion related to an existing part of the documentation? -->
31+
<!--- Please add one of more here here. -->
32+
<!--- [#Link 1](#) -->
33+
<!--- [#Link 2](#) -->
34+
35+
36+
### Related issues, RFCs
37+
38+
<!--- Add here the link to one or more Github Issues or RFCs that are related to this PR. -->
39+
<!--- [#XXXXX](https://github.com/awslabs/aws-lambda-powertools-typescript/issues/XXXXX) -->
40+
<!--- [#ZZZZZ](https://github.com/awslabs/aws-lambda-powertools-typescript/issues/ZZZZZ) -->

Diff for: ‎.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: "(module name): short issue description"
5+
labels: feature-request, triage
6+
assignees: saragerion, alan-churley
7+
8+
---
9+
10+
<!--- 1. Make sure you follow our Contributing Guidelines: https://github.com/awslabs/aws-lambda-powertools-typescript/blob/main/CONTRIBUTING.md -->
11+
<!--- 2. Please follow the template, and do not remove any section in the template. If something is not applicable leave it empty, but leave it in the issue. -->
12+
13+
## Description of the feature request
14+
15+
**Problem statement**
16+
<!--- If applicable, help us understand which problem you are trying to solve: add a clear and concise description of what the problem is. -->
17+
18+
**Summary of the feature**
19+
<!--- Include here a summary of the proposal, including relevant motivation and context. -->
20+
21+
<!--- Please add clear description of what you want to achieve. -->
22+
23+
**Code examples**
24+
<!-- Share how the developer experience would look like, also with relevant code examples. -->
25+
26+
**Benefits for you and the wider AWS community**
27+
<!-- What are the benefits your your proposed feature? -->
28+
29+
**Describe alternatives you've considered**
30+
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
31+
32+
**Additional context**
33+
<!-- Add any other context or screenshots about the feature request here. -->
34+
35+
### Related issues, RFCs
36+
37+
<!--- Add here the link to one or more Github Issues or RFCs that are related to this PR. -->
38+
<!--- [#XXXXX](https://github.com/awslabs/aws-lambda-powertools-typescript/issues/XXXXX) -->
39+
<!--- [#ZZZZZ](https://github.com/awslabs/aws-lambda-powertools-typescript/issues/ZZZZZ) -->

Diff for: ‎.github/ISSUE_TEMPLATE/bug_report.md

-45
This file was deleted.

Diff for: ‎.github/ISSUE_TEMPLATE/config.yml

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false

Diff for: ‎.github/ISSUE_TEMPLATE/documentation-improvements.md

-17
This file was deleted.

Diff for: ‎.github/ISSUE_TEMPLATE/feature_request.md

-20
This file was deleted.

Diff for: ‎.github/ISSUE_TEMPLATE/rfc.md

-52
This file was deleted.

Diff for: ‎.github/PULL_REQUEST_TEMPLATE.md

+42-14
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,53 @@
1-
**Issue #, if available:**
1+
<!--- 1. Make sure you follow our Contributing Guidelines: https://github.com/awslabs/aws-lambda-powertools-typescript/blob/main/CONTRIBUTING.md -->
2+
<!--- 2. Please follow the template, and do not remove any section in the template. If something is not applicable leave it empty, but leave it in the PR. -->
23

3-
## Description of changes:
4+
## Description of your changes
45

5-
<!--- One or two sentences as a summary of what's being changed -->
6+
<!--- Include here a summary of the change. -->
67

7-
**Checklist**
8+
<!--- Please include also relevant motivation and context. -->
89

9-
<!--- Leave unchecked if your change doesn't seem to apply -->
10+
<!--- List any dependencies that are required for this change. -->
1011

11-
* [ ] [Meet tenets criteria](https://awslabs.github.io/aws-lambda-powertools-typescript/#tenets)
12-
* [ ] Update tests
13-
* [ ] Update docs
14-
* [ ] PR title follows [conventional commit semantics](https://github.com/awslabs/aws-lambda-powertools-typescript/blob/main/.github/semantic.yml#L2)
12+
<!--- If this PR is part of a sequence of related PRs or TODOs, list the high level TODO items. -->
1513

16-
## Breaking change checklist
14+
### How to verify this change
1715

18-
<!--- Ignore if it's not a breaking change -->
16+
<!--- Add any applicable config, projects, screenshots or other resources -->
17+
<!--- that can help us verify your changes. -->
1918

20-
**RFC issue #**:
19+
<!--- Examples: -->
20+
<!--- Screenshots, cloud configuration, anything helping us evaluate better. -->
2121

22-
* [ ] Migration process documented
23-
* [ ] Implement warnings (if it can live side by side)
22+
### Related issues, RFCs
23+
24+
<!--- Add here the link to one or more Github Issues or RFCs that are related to this PR. -->
25+
[#XXXXX](https://github.com/awslabs/aws-lambda-powertools-typescript/issues/XXXXX)
26+
[#ZZZZZ](https://github.com/awslabs/aws-lambda-powertools-typescript/issues/ZZZZZ)
27+
28+
### PR status
29+
30+
***Is this ready for review?:*** NO
31+
***Is it a breaking change?:*** NO
32+
33+
## Checklist
34+
35+
- [ ] [My changes meet the tenets criteria](https://awslabs.github.io/aws-lambda-powertools-python/#tenets)
36+
- [ ] I have performed a *self-review* of my own code
37+
- [ ] I have *commented* my code where necessary, particularly in areas that should be flagged with a TODO, or hard-to-understand areas
38+
- [ ] I have made corresponding changes to the *documentation*
39+
- [ ] My changes generate *no new warnings*
40+
- [ ] The *code coverage* hasn't decreased
41+
- [ ] I have *added tests* that prove my change is effective and works
42+
- [ ] New and existing *unit tests pass* locally and in Github Actions
43+
- [ ] Any *dependent changes have been merged and published* in downstream module
44+
- [ ] The PR title follows the [conventional commit semantics](https://github.com/awslabs/aws-lambda-powertools-typescript/blob/main/.github/semantic.yml#L2)
45+
46+
### Breaking change checklist
47+
48+
- [ ] I have documented the migration process
49+
- [ ] I have added, implemented necessary warnings (if it can live side by side)
50+
51+
---
2452

2553
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Diff for: ‎.github/dependabot.yml

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
version: 2
2+
updates:
3+
4+
# Maintain dependencies for GitHub Actions
5+
- package-ecosystem: "github-actions"
6+
directory: "/"
7+
schedule:
8+
interval: "weekly"
9+
10+
# Maintain dependencies for npm
11+
- package-ecosystem: "npm"
12+
directory: "/"
13+
schedule:
14+
interval: "daily"

Diff for: ‎.github/workflows/closed-issues-message.yml

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: Closed Issue Message
2+
on:
3+
issues:
4+
types: [closed]
5+
jobs:
6+
auto_comment:
7+
runs-on: ubuntu-latest
8+
steps:
9+
- uses: aws-actions/closed-issue-message@v1
10+
with:
11+
# These inputs are both required
12+
repo-token: "${{ secrets.GITHUB_TOKEN }}"
13+
message: |
14+
### ⚠️COMMENT VISIBILITY WARNING⚠️
15+
Comments on closed issues are hard for our team to see.
16+
If you need more assistance, please either tag a team member or open a new issue that references this one.
17+
If you wish to keep having a conversation with other community members under this issue feel free to do so.

0 commit comments

Comments
 (0)