Skip to content

Commit fb67a13

Browse files
author
Alan Churley
committed
Initial commit
0 parents  commit fb67a13

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+25370
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: bug, triage
6+
assignees: ''
7+
8+
---
9+
10+
<!--- Provide a general summary of the issue in the Title above -->
11+
<!--- How has this issue affected you? What are you trying to accomplish? -->
12+
13+
**What were you trying to accomplish?**
14+
15+
## Expected Behavior
16+
<!--- If you're describing a bug, tell us what should happen -->
17+
<!--- If you're suggesting a change/improvement, tell us how it should work -->
18+
19+
## Current Behavior
20+
<!--- If describing a bug, tell us what happens instead of the expected behavior -->
21+
<!--- If suggesting a change/improvement, explain the difference from current behavior -->
22+
23+
## Possible Solution
24+
<!--- Not obligatory, but suggest a fix/reason for the bug, -->
25+
<!--- or ideas how to implement the addition or change -->
26+
27+
## Steps to Reproduce (for bugs)
28+
<!--- Provide a link to a live example, or an unambiguous set of steps to -->
29+
<!--- reproduce this bug. Include code to reproduce, if relevant -->
30+
1.
31+
2.
32+
3.
33+
4.
34+
35+
## Environment
36+
37+
* **Powertools version used**:
38+
* **Packaging format (Layers, npm)**:
39+
* **AWS Lambda function runtime:**
40+
* **Debugging logs**
41+
42+
43+
```python
44+
# paste logs here
45+
```

‎.github/ISSUE_TEMPLATE/documentation-improvements.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: Documentation improvements
3+
about: Suggest a documentation update
4+
title: ''
5+
labels: documentation
6+
assignees: ''
7+
8+
---
9+
10+
**What were you initially searching for in the docs?**
11+
<!-- Please help us understand how you looked for information that was either not available or unclear -->
12+
13+
**Is this related to an existing part of the documentation? Please share a link**
14+
15+
**Describe how we could make it clearer**
16+
17+
**If you have a proposed update, please share it here**

‎.github/ISSUE_TEMPLATE/feature_request.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: feature-request, triage
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
12+
13+
**Describe the solution you'd like**
14+
<!-- A clear and concise description of what you want to happen. -->
15+
16+
**Describe alternatives you've considered**
17+
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
18+
19+
**Additional context**
20+
<!-- Add any other context or screenshots about the feature request here. -->

‎.github/ISSUE_TEMPLATE/rfc.md

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
name: RFC
3+
about: Feature design and proposals
4+
title: 'RFC: '
5+
labels: RFC, triage
6+
assignees: ''
7+
8+
---
9+
10+
## Key information
11+
12+
* RFC PR: (leave this empty)
13+
* Related issue(s), if known:
14+
* Area: (i.e. Tracer, Metrics, Logger, etc.)
15+
* Meet [tenets](https://awslabs.github.io/aws-lambda-powertools-typescript/#tenets): (Yes/no)
16+
17+
## Summary
18+
[summary]: #summary
19+
20+
> One paragraph explanation of the feature.
21+
22+
## Motivation
23+
[motivation]: #motivation
24+
25+
> Why are we doing this? What use cases does it support? What is the expected outcome?
26+
27+
## Proposal
28+
[proposal]: #proposal
29+
30+
> This is the bulk of the RFC.
31+
32+
> Explain the design in enough detail for somebody familiar with Powertools to understand it, and for somebody familiar with the implementation to implement it.
33+
34+
> This should get into specifics and corner-cases, and include examples of how the feature is used. Any new terminology should be defined here.
35+
36+
## Drawbacks
37+
[drawbacks]: #drawbacks
38+
39+
> Why should we *not* do this?
40+
41+
> Do we need additional dependencies? Impact performance/package size?
42+
43+
## Rationale and alternatives
44+
[rationale-and-alternatives]: #rationale-and-alternatives
45+
46+
* **What other designs have been considered? Why not them?**
47+
* **What is the impact of not doing this?**
48+
49+
## Unresolved questions
50+
[unresolved-questions]: #unresolved-questions
51+
52+
> Optional, stash area for topics that need further development e.g. TBD

‎.github/PULL_REQUEST_TEMPLATE.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
**Issue #, if available:**
2+
3+
## Description of changes:
4+
5+
<!--- One or two sentences as a summary of what's being changed -->
6+
7+
**Checklist**
8+
9+
<!--- Leave unchecked if your change doesn't seem to apply -->
10+
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)
15+
16+
## Breaking change checklist
17+
18+
<!--- Ignore if it's not a breaking change -->
19+
20+
**RFC issue #**:
21+
22+
* [ ] Migration process documented
23+
* [ ] Implement warnings (if it can live side by side)
24+
25+
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

‎.github/auto_assign-issues.yml

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
addAssignees: true
2+
3+
# The list of users to assign to new issues.
4+
# If empty or not provided, the repository owner is assigned
5+
assignees:
6+
- alan-churley
7+
- saragerion

‎.github/release-drafter.yml

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
change-template: "* $TITLE (#$NUMBER) by @$AUTHOR"
2+
categories:
3+
- title: '⚡ Breaking Changes'
4+
labels:
5+
- 'breaking-change'
6+
- title: '🌟New features and non-breaking changes'
7+
labels:
8+
- 'major'
9+
- 'feature'
10+
- title: '🌟 Minor Changes'
11+
labels:
12+
- 'enhancement'
13+
- title: '📜 Documentation updates'
14+
labels:
15+
- 'documentation'
16+
- title: '🐛 Bug and hot fixes'
17+
labels:
18+
- 'bug'
19+
- 'fix'
20+
- title: '🚒 Deprecations'
21+
labels:
22+
- 'deprecated'
23+
exclude-labels:
24+
- 'skip-changelog'
25+
tag-template: 'v$NEXT_PATCH_VERSION'
26+
template: |
27+
## Changes
28+
29+
**[Human readable summary of changes]**
30+
31+
$CHANGES
32+
33+
## This release was made possible by the following contributors:
34+
35+
$CONTRIBUTORS

‎.github/semantic.yml

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# conventional commit types: https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json
2+
types:
3+
- feat
4+
- fix
5+
- docs
6+
- style
7+
- refactor
8+
- perf
9+
- test
10+
- build
11+
- ci
12+
- chore
13+
- revert
14+
- improv
15+
16+
# Always validate the PR title
17+
# and ignore the commits to lower the entry bar for contribution
18+
# while titles make up the Release notes to ease maintenance overhead
19+
titleOnly: true

‎.github/stale.yml

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
only: issues
2+
daysUntilStale: 30
3+
daysUntilClose: 7
4+
exemptLabels:
5+
- bug
6+
- documentation
7+
- enhancement
8+
- feature-request
9+
- RFC
10+
staleLabel: pending-close-response-required
11+
markComment: >
12+
This issue has been automatically marked as stale because it has not had
13+
recent activity. It will be closed if no further activity occurs. Thank you
14+
for your contributions.
15+
closeComment: >
16+
This issue has been automatically closed because of inactivity.
17+
Please open a new issue if you are still encountering problems.

‎.github/workflows/codeql-analysis.yml

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
#name: "CodeQL"
2+
#
3+
#on:
4+
# push:
5+
# branches: [main]
6+
# pull_request:
7+
# branches: [main]
8+
# schedule:
9+
# - cron: '0 21 * * 0'
10+
#
11+
#jobs:
12+
# analyze:
13+
# name: Analyze
14+
# runs-on: ubuntu-latest
15+
#
16+
# strategy:
17+
# fail-fast: false
18+
# matrix:
19+
# # Override automatic language detection by changing the below list
20+
# # Supported options are ['csharp', 'cpp', 'go', 'java', 'javascript', 'python']
21+
# language: ['javascript']
22+
# # Learn more...
23+
# # https://docs.github.com/en/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#overriding-automatic-language-detection
24+
#
25+
# steps:
26+
# - name: Checkout repository
27+
# uses: actions/checkout@v2
28+
#
29+
# # Initializes the CodeQL tools for scanning.
30+
# - name: Initialize CodeQL
31+
# uses: github/codeql-action/init@v1
32+
# with:
33+
# languages: ${{ matrix.language }}
34+
# # If you wish to specify custom queries, you can do so here or in a config file.
35+
# # By default, queries listed here will override any specified in a config file.
36+
# # Prefix the list here with "+" to use these queries and those in the config file.
37+
# # queries: ./path/to/local/query, your-org/your-repo/queries@main
38+
#
39+
# - name: Perform CodeQL Analysis
40+
# uses: github/codeql-action/analyze@v1

‎.github/workflows/test.yml

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: Test
2+
on:
3+
push:
4+
branches: [ main ]
5+
pull_request:
6+
branches: [ main ]
7+
8+
jobs:
9+
test:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/checkout@v2
13+
- name: Install modules
14+
run: npm install
15+
- name: Run lint
16+
run: npm run lint
17+
- name: Run tests
18+
run: npm run test
19+
- name: Report Coverage
20+
if: ${{ github.event_name == 'pull_request' }}
21+
uses: romeovs/[email protected]
22+
with:
23+
github-token: ${{ secrets.GITHUB_TOKEN }}
24+
lcov-file: ./coverage/lcov.info

‎.gitignore

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
node_modules
2+
/lib
3+
/coverage
4+
.idea/

‎.prettierrc

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"printWidth": 120,
3+
"trailingComma": "all",
4+
"singleQuote": true
5+
}

‎CODE_OF_CONDUCT.md

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
## Code of Conduct
2+
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
3+
For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
4+
[email protected] with any additional questions or comments.

‎CONTRIBUTING.md

+59
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# Contributing Guidelines
2+
3+
Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional
4+
documentation, we greatly value feedback and contributions from our community.
5+
6+
Please read through this document before submitting any issues or pull requests to ensure we have all the necessary
7+
information to effectively respond to your bug report or contribution.
8+
9+
10+
## Reporting Bugs/Feature Requests
11+
12+
We welcome you to use the GitHub issue tracker to report bugs or suggest features.
13+
14+
When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already
15+
reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
16+
17+
* A reproducible test case or series of steps
18+
* The version of our code being used
19+
* Any modifications you've made relevant to the bug
20+
* Anything unusual about your environment or deployment
21+
22+
23+
## Contributing via Pull Requests
24+
Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
25+
26+
1. You are working against the latest source on the *master* branch.
27+
2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
28+
3. You open an issue to discuss any significant work - we would hate for your time to be wasted.
29+
30+
To send us a pull request, please:
31+
32+
1. Fork the repository.
33+
2. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change.
34+
3. Ensure local tests pass.
35+
4. Commit to your fork using clear commit messages.
36+
5. Send us a pull request, answering any default questions in the pull request interface.
37+
6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
38+
39+
GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
40+
[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
41+
42+
43+
## Finding contributions to work on
44+
Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any 'help wanted' issues is a great place to start.
45+
46+
47+
## Code of Conduct
48+
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
49+
For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
50+
[email protected] with any additional questions or comments.
51+
52+
53+
## Security issue notifications
54+
If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue.
55+
56+
57+
## Licensing
58+
59+
See the [LICENSE](LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.

0 commit comments

Comments
 (0)