Skip to content

improv: repository documentation, metadata, github actions, dot files #17

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
merged 3 commits into from
Apr 7, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
coverage
lib
node_modules
tests/resources/*
1 change: 0 additions & 1 deletion .eslintrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ module.exports = {
'plugin:@typescript-eslint/eslint-recommended',
'plugin:@typescript-eslint/recommended'
],
ignorePatterns: ['tests/resources/*'],
parser: '@typescript-eslint/parser',
plugins: ['@typescript-eslint'],
rules: {
Expand Down
4 changes: 4 additions & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# These owners will be the default owners for everything in
# the repo.
# TODO: revisit this list
* @saragerion, @alan-churley, @heitorlessa
53 changes: 53 additions & 0 deletions .github/ISSUE_TEMPLATE/BUG_REPORT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
name: Bug report
about: Create a report to help us improve
title: "(module name): short issue description"
labels: bug, triage
assignees: saragerion, alan-churley

---

<!--- Before you start, make sure that the bug hasn't been reported already https://github.com/awslabs/aws-lambda-powertools-typescript/issues -->
<!--- 1. Make sure you follow our Contributing Guidelines: https://github.com/awslabs/aws-lambda-powertools-typescript/blob/main/CONTRIBUTING.md -->
<!--- 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. -->
<!--- 3. Provide a general summary of the issue in the Title above -->

## Bug description

<!--- Provide a summary of the bug here. -->

<!--- What were you trying to accomplish? -->

### Expected Behavior

<!--- Tell us what should happen. -->

### Current Behavior

<!--- Tell us what happens instead of the expected behavior. -->

### Possible Solution

<!--- Not obligatory, but suggest a fix/solutions/implementation for the bug. -->

### Steps to Reproduce

<!--- Provide a link to a live example, or an unambiguous set of steps to -->
<!--- reproduce this bug. Include code to reproduce, if relevant. -->
1.
2.
3.
4.

### Environment

* **Powertools version used**:
* **Packaging format (Layers, npm)**:
* **AWS Lambda function runtime:**
* **Debugging logs:**

### Related issues, RFCs

<!--- Add here the link to one or more Github Issues or RFCs that are related to this PR. -->
<!--- [#XXXXX](https://github.com/awslabs/aws-lambda-powertools-typescript/issues/XXXXX) -->
<!--- [#ZZZZZ](https://github.com/awslabs/aws-lambda-powertools-typescript/issues/ZZZZZ) -->
40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/DOC_IMPROVEMENT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
name: Documentation improvement
about: Suggest a documentation update, improvement
title: "(module name): short issue description"
labels: documentation
assignees: saragerion, alan-churley

---

<!--- 1. Make sure you follow our Contributing Guidelines: https://github.com/awslabs/aws-lambda-powertools-typescript/blob/main/CONTRIBUTING.md -->
<!--- 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. -->

## Description of the improvement

**Summary of the proposal**
<!--- Include here a summary of the proposal, including relevant motivation and context. -->

**How, where did you look for information**
<!--- Help us understand how you looked for information that was either not available or unclear. -->

**Missing or unclear documentation**
<!--- What were you initially looking for in the docs? -->

**Improvement**
<!--- Describe how we could make it clearer. -->
<!--- Feel free to add specific examples. -->

### Related existing documentation

<!--- Is your suggestion related to an existing part of the documentation? -->
<!--- Please add one of more here here. -->
<!--- [#Link 1](#) -->
<!--- [#Link 2](#) -->


### Related issues, RFCs

<!--- Add here the link to one or more Github Issues or RFCs that are related to this PR. -->
<!--- [#XXXXX](https://github.com/awslabs/aws-lambda-powertools-typescript/issues/XXXXX) -->
<!--- [#ZZZZZ](https://github.com/awslabs/aws-lambda-powertools-typescript/issues/ZZZZZ) -->
39 changes: 39 additions & 0 deletions .github/ISSUE_TEMPLATE/FEATURE_REQUEST.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
name: Feature request
about: Suggest an idea for this project
title: "(module name): short issue description"
labels: feature-request, triage
assignees: saragerion, alan-churley

---

<!--- 1. Make sure you follow our Contributing Guidelines: https://github.com/awslabs/aws-lambda-powertools-typescript/blob/main/CONTRIBUTING.md -->
<!--- 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. -->

## Description of the feature request

**Problem statement**
<!--- If applicable, help us understand which problem you are trying to solve: add a clear and concise description of what the problem is. -->

**Summary of the feature**
<!--- Include here a summary of the proposal, including relevant motivation and context. -->

<!--- Please add clear description of what you want to achieve. -->

**Code examples**
<!-- Share how the developer experience would look like, also with relevant code examples. -->

**Benefits for you and the wider AWS community**
<!-- What are the benefits your your proposed feature? -->

**Describe alternatives you've considered**
<!-- A clear and concise description of any alternative solutions or features you've considered. -->

**Additional context**
<!-- Add any other context or screenshots about the feature request here. -->

### Related issues, RFCs

<!--- Add here the link to one or more Github Issues or RFCs that are related to this PR. -->
<!--- [#XXXXX](https://github.com/awslabs/aws-lambda-powertools-typescript/issues/XXXXX) -->
<!--- [#ZZZZZ](https://github.com/awslabs/aws-lambda-powertools-typescript/issues/ZZZZZ) -->
45 changes: 0 additions & 45 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
17 changes: 0 additions & 17 deletions .github/ISSUE_TEMPLATE/documentation-improvements.md

This file was deleted.

20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

52 changes: 0 additions & 52 deletions .github/ISSUE_TEMPLATE/rfc.md

This file was deleted.

56 changes: 42 additions & 14 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,53 @@
**Issue #, if available:**
<!--- 1. Make sure you follow our Contributing Guidelines: https://github.com/awslabs/aws-lambda-powertools-typescript/blob/main/CONTRIBUTING.md -->
<!--- 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. -->

## Description of changes:
## Description of your changes

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

**Checklist**
<!--- Please include also relevant motivation and context. -->

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

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

## Breaking change checklist
### How to verify this change

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

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

* [ ] Migration process documented
* [ ] Implement warnings (if it can live side by side)
### Related issues, RFCs

<!--- Add here the link to one or more Github Issues or RFCs that are related to this PR. -->
[#XXXXX](https://github.com/awslabs/aws-lambda-powertools-typescript/issues/XXXXX)
[#ZZZZZ](https://github.com/awslabs/aws-lambda-powertools-typescript/issues/ZZZZZ)

### PR status

***Is this ready for review?:*** NO
***Is it a breaking change?:*** NO

## Checklist

- [ ] [My changes meet the tenets criteria](https://awslabs.github.io/aws-lambda-powertools-python/#tenets)
- [ ] I have performed a *self-review* of my own code
- [ ] I have *commented* my code where necessary, particularly in areas that should be flagged with a TODO, or hard-to-understand areas
- [ ] I have made corresponding changes to the *documentation*
- [ ] My changes generate *no new warnings*
- [ ] The *code coverage* hasn't decreased
- [ ] I have *added tests* that prove my change is effective and works
- [ ] New and existing *unit tests pass* locally and in Github Actions
- [ ] Any *dependent changes have been merged and published* in downstream module
- [ ] The PR title follows the [conventional commit semantics](https://github.com/awslabs/aws-lambda-powertools-typescript/blob/main/.github/semantic.yml#L2)

### Breaking change checklist

- [ ] I have documented the migration process
- [ ] I have added, implemented necessary warnings (if it can live side by side)

---

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
14 changes: 14 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
version: 2
updates:

# Maintain dependencies for GitHub Actions
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "weekly"

# Maintain dependencies for npm
- package-ecosystem: "npm"
directory: "/"
schedule:
interval: "daily"
17 changes: 17 additions & 0 deletions .github/workflows/closed-issues-message.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: Closed Issue Message
on:
issues:
types: [closed]
jobs:
auto_comment:
runs-on: ubuntu-latest
steps:
- uses: aws-actions/closed-issue-message@v1
with:
# These inputs are both required
repo-token: "${{ secrets.GITHUB_TOKEN }}"
message: |
### ⚠️COMMENT VISIBILITY WARNING⚠️
Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.
Loading