Merge pull request #1 from sliedig/develop

chore: Initial project structure

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,46 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug, triage
+assignees: ''
+
+---
+
+<!--- Provide a general summary of the issue in the Title above -->
+<!--- How has this issue affected you? What are you trying to accomplish? -->
+
+**What were you trying to accomplish?**
+
+## Expected Behavior
+<!--- If you're describing a bug, tell us what should happen -->
+<!--- If you're suggesting a change/improvement, tell us how it should work -->
+
+## Current Behavior
+<!--- If describing a bug, tell us what happens instead of the expected behavior -->
+<!--- If suggesting a change/improvement, explain the difference from current behavior -->
+
+## Possible Solution
+<!--- Not obligatory, but suggest a fix/reason for the bug, -->
+<!--- or ideas how to implement the addition or change -->
+
+## Steps to Reproduce (for bugs)
+<!--- 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, Maven/Gradle)**:
+* **AWS Lambda function runtime:**
+* **Debugging logs**
+
+> [How to enable debug mode](https://awslabs.github.io/aws-lambda-powertools-dotnet/#debug-mode)**
+
+```net
+# paste logs here
+```

.github/ISSUE_TEMPLATE/documentation-improvements.md

@@ -0,0 +1,17 @@
+---
+name: Documentation improvements
+about: Suggest a documentation update
+title: ''
+labels: documentation
+assignees: ''
+
+---
+
+**What were you initially searching for in the docs?**
+<!-- Please help us understand how you looked for information that was either not available or unclear -->
+
+**Is this related to an existing part of the documentation? Please share a link**
+
+**Describe how we could make it clearer**
+
+**If you have a proposed update, please share it here**

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: feature-request, triage
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
+
+**Describe the solution you'd like**
+<!-- A clear and concise description of what you want to happen. -->
+
+**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. -->

.github/ISSUE_TEMPLATE/rfc.md

@@ -0,0 +1,52 @@
+---
+name: RFC
+about: Feature design and proposals
+title: 'RFC: '
+labels: RFC, triage
+assignees: ''
+
+---
+
+## Key information
+
+* RFC PR: (leave this empty)
+* Related issue(s), if known:
+* Area: (i.e. Tracer, Metrics, Logger, etc.)
+* Meet [tenets](https://awslabs.github.io/aws-lambda-powertools-dotnet/#tenets): (Yes/no)
+
+## Summary
+[summary]: #summary
+
+> One paragraph explanation of the feature.
+
+## Motivation
+[motivation]: #motivation
+
+> Why are we doing this? What use cases does it support? What is the expected outcome?
+
+## Proposal
+[proposal]: #proposal
+
+> This is the bulk of the RFC.
+
+> Explain the design in enough detail for somebody familiar with Powertools to understand it, and for somebody familiar with the implementation to implement it.
+
+> This should get into specifics and corner-cases, and include examples of how the feature is used. Any new terminology should be defined here.
+
+## Drawbacks
+[drawbacks]: #drawbacks
+
+> Why should we *not* do this?
+
+> Do we need additional dependencies? Impact performance/package size?
+
+## Rationale and alternatives
+[rationale-and-alternatives]: #rationale-and-alternatives
+
+* **What other designs have been considered? Why not them?**
+* **What is the impact of not doing this?**
+
+## Unresolved questions
+[unresolved-questions]: #unresolved-questions
+
+> Optional, stash area for topics that need further development e.g. TBD

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,25 @@
+**Issue #, if available:**
+
+## Description of changes:
+
+<!--- One or two sentences as a summary of what's being changed -->
+
+**Checklist**
+
+<!--- Leave unchecked if your change doesn't seem to apply --> 
+
+* [ ] [Meet tenets criteria](https://awslabs.github.io/aws-lambda-powertools-dotnet/#tenets)
+* [ ] Update tests
+* [ ] Update docs
+* [ ] PR title follows [conventional commit semantics]()
+
+## Breaking change checklist
+
+<!--- Ignore if it's not a breaking change -->
+
+**RFC issue #**:
+
+* [ ] Migration process documented
+* [ ] Implement 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.

.github/release-drafter.yml

@@ -0,0 +1,35 @@
+change-template: "* $TITLE (#$NUMBER) by @$AUTHOR"
+categories:
+  - title: '⚡ Breaking Changes'
+    labels:
+      - 'breaking-change'
+  - title: '🌟New features and non-breaking changes'
+    labels:
+      - 'major'
+      - 'feature'
+  - title: '🌟 Minor Changes'
+    labels:
+      - 'enhancement'
+  - title: '📜 Documentation updates'
+    labels:
+      - 'documentation'
+  - title: '🐛 Bug and hot fixes'
+    labels:
+      - 'bug'
+      - 'fix'
+  - title: '🚒 Deprecations'
+    labels:
+      - 'deprecated'
+exclude-labels:
+  - 'skip-changelog'
+tag-template: 'v$NEXT_PATCH_VERSION'
+template: |
+  ## Changes
+
+  **[Human readable summary of changes]**
+
+  $CHANGES
+
+  ## This release was made possible by the following contributors:
+
+  $CONTRIBUTORS

.github/semantic.yml

@@ -0,0 +1,19 @@
+# conventional commit types: https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json
+types:
+  - feat
+  - fix
+  - docs
+  - style
+  - refactor
+  - perf
+  - test
+  - build
+  - ci
+  - chore
+  - revert
+  - improv
+
+# Always validate the PR title
+# and ignore the commits to lower the entry bar for contribution
+# while titles make up the Release notes to ease maintenance overhead
+titleOnly: true

.github/stale.yml

@@ -0,0 +1,17 @@
+only: issues
+daysUntilStale: 30
+daysUntilClose: 7
+exemptLabels:
+  - bug
+  - documentation
+  - enhancement
+  - feature-request
+  - RFC
+staleLabel: pending-close-response-required
+markComment: >
+  This issue has been automatically marked as stale because it has not had
+  recent activity. It will be closed if no further activity occurs. Thank you
+  for your contributions.
+closeComment: >
+  This issue has been automatically closed because of inactivity.
+  Please open a new issue if you are still encountering problems.

.github/workflows/build.yml

@@ -0,0 +1,28 @@
+name: Build
+
+on:
+  pull_request:
+    branches:
+      - master
+  push:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      max-parallel: 4
+      matrix:
+        # test against latest update of each major .NET version, as well as specific updates of LTS versions:
+        dotnet: [3.1.6]
+    name: dotnet ${{ matrix.dotnet }}
+    env:
+      OS: ${{ matrix.os }}
+      NET: ${{ matrix.dotnet-version }}
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup .NET core
+        uses: actions/setup-dotnet@v1
+        with:
+          dotnet-version: ${{ matrix.java }}
+      - name: Build with dotnet
+        run: dotnet build --configuration Release

.github/workflows/docs.yml

@@ -0,0 +1,37 @@
+name: Docs
+
+on:
+  pull_request:
+    branches:
+      - master
+  push:
+    branches:
+      - master
+      # Disabled until docs support versioning per branch/release
+      # - develop
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: borales/[email protected]
+      - name: Set up Python
+        uses: actions/setup-python@v1
+        with:
+          python-version: "3.8"
+      - name: Capture branch and tag
+        id: branch_name
+        run: |
+          echo ::set-env name=SOURCE_BRANCH::${GITHUB_REF#refs/heads/}
+          echo ::set-env name=SOURCE_TAG::${GITHUB_REF#refs/tags/}
+
+      - name: install dependencies
+        run: make dev-docs
+      - name: Build docs website
+        run: make build-docs-website
+      - name: Deploy all docs
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./dist

.github/workflows/release-drafter.yml

@@ -0,0 +1,15 @@
+name: Release Drafter
+
+on:
+  push:
+    # branches to consider in the event; optional, defaults to all
+    branches:
+      - develop
+
+jobs:
+  update_release_draft:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: release-drafter/release-drafter@v5
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}