readme and repolinter updates

CoreySchnedl · CoreySchnedl · commit d2e6605c401a · 2024-07-25T11:24:05.000-04:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,9 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## [0.0.1] - 2024-07-15
+### Added
+- Initial Release
diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md
@@ -0,0 +1,14 @@
+### Subject of the issue
+Describe your issue here.
+
+### Your environment
+Provide details about your environment.
+
+### Steps to reproduce
+Tell us how to reproduce this issue. Please provide a working demo if possible.
+
+### Expected behaviour
+Tell us what should happen
+
+### Actual behaviour
+Tell us what happens instead
diff --git a/README.md b/README.md
@@ -64,6 +64,8 @@ We recommend using the open-source API testing tool known as (Bruno)[https://www
 9. Invoke your API using the '->' button for the selected request.
 10. Take note on how Validation (passing in non-number values) is handled in V1 compared to V2.
 
+![Example API Invocation with Bruno](./images/api-testing-with-bruno.png)
+
 #### Important Security Considerings Regarding the Sample Implementation
 
 The sample CDK application uses CDK nag with AWSSolutionsChecks to help improve security. However, some CDK issues are suppressed in order to keep the sample proof-of-concept application simple to use. _These suppressions should be remediated before use in a production-ready implementation._
diff --git a/SECURITY.md b/SECURITY.md
@@ -0,0 +1,14 @@
+- [Security Policy](#security-policy)
+  - [Supported Versions](#supported-versions)
+  - [Reporting a Vulnerability](#reporting-a-vulnerability)
+
+# Security Policy
+
+## Supported Versions
+
+## Reporting a Vulnerability
+
+Please report (suspected) security vulnerabilities to
+**[cschnedl@amazon.com](mailto:cschnedl@amazon.com)**. You will receive a response from
+us within 48 hours. If the issue is confirmed, we will release a patch as soon
+as possible depending on complexity but historically within a few days.
diff --git a/SUPPORT.md b/SUPPORT.md
@@ -0,0 +1,9 @@
+# Support
+
+## How to file issues and get help  
+
+This project uses GitHub Issues to track bugs and feature requests. Please search the existing 
+issues before filing new issues to avoid duplicates.  For new issues, file your bug or 
+feature request as a new Issue.
+
+For help and questions about using this project, please create a GitHub Issue.
diff --git a/docs/pull_request_template.md b/docs/pull_request_template.md
@@ -0,0 +1,32 @@
+## Description
+<!--
+Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change.
+-->
+
+## What type of PR is this? (check all applicable)
+
+- [ ] 🍕 Feature
+- [ ] 🐛 Bug Fix
+- [ ] 📝 Documentation Update
+- [ ] 🧑‍💻 Code Refactor / No Functional Changes
+- [ ] 🔥 Performance Improvements
+- [ ] ⚠️ Security Vulnerability Remediation
+- [ ] ✅ Adding Tests
+- [ ] 🤖 Developer Workstation Updates
+- [ ] 🔁 CI/CD Updates
+- [ ] ⏩ Revert Previous Change
+
+## Related Tickets & Documents
+<!-- 
+GitHub Issue Link: 
+-->
+
+## [Optional] Screenshots/Recordings
+<!--
+Potentially Add a before/after screenshot(s) if possible
+-->
+
+## Developer Checklist
+
+- [ ] 📝 Updated any relevant documentation
+
diff --git a/images/api-testing-with-bruno.png b/images/api-testing-with-bruno.png
