Merge pull request #10 from FreeRTOS/dev

Dev

Author: jasonpcarroll

.github/CODEOWNERS

@@ -0,0 +1 @@
+*      @FreeRTOS/pr-bar-raiser

.github/CODE_OF_CONDUCT.md

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

.github/CONTRIBUTING.md

@@ -0,0 +1,65 @@
+# Contributing Guidelines
+
+Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional
+documentation, we greatly value feedback and contributions from our community.
+
+Please read through this document before submitting any issues or pull requests to ensure we have all the necessary
+information to effectively respond to your bug report or contribution.
+
+
+## Reporting Bugs/Feature Requests
+
+We welcome you to use the GitHub issue tracker to report bugs or suggest features.
+
+When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already
+reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
+
+* A reproducible test case or series of steps
+* The version of our code being used
+* Any modifications you've made relevant to the bug
+* Anything unusual about your environment or deployment
+
+
+## Contributing via Pull Requests
+Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
+
+1. You are working against the latest source on the *main* branch.
+2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
+3. You open an issue to discuss any significant work - we would hate for your time to be wasted.
+
+To send us a pull request, please:
+
+1. Ensure you are considering a change to AWS source code (FreeRTOS kernel, AWS libraries).  Proposed changes to 3rd party code should be submitted instead to the 3rd party.
+2. Fork the repository.
+3. 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.
+4. Ensure local tests pass.
+5. Commit to your fork using clear commit messages.
+6. Send us a pull request, answering any default questions in the pull request interface.
+7. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
+
+GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
+[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
+
+## Getting Your Pull Request Merged
+All Pull Requests must be approved by our review team before it can be merged in. We appreciate your patience while pull requests are reviewed as the time taken will depend on its complexity and wider implications.
+
+
+## Finding contributions to work on
+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.
+
+
+## Code of Conduct
+This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
+For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
+[email protected] with any additional questions or comments.
+
+
+## Security issue notifications
+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.
+
+
+## Licensing
+
+See the LICENSE file for our project's licensing. We will ask you to confirm the licensing of your contribution.
+
+We may ask you to sign a [Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes.

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,44 @@
+---
+name: Bug Report
+about: Create a report to help us improve iot-reference-esp32c3 by identifying any confirmed
+  bugs. To discuss a potential bug, or pose other inquiries, please open an issue
+  using the template linked below.
+title: "[BUG] <replace with your title>"
+labels: 'Type: Bug'
+assignees: ''
+
+---
+
+**Describe the bug**
+Please provide a clear and concise description explaining the bug.
+
+**System information**
+- Hardware board: [ ... ]
+- IDE used: [ ... ]
+- Operating System: [ Windows | Linux | MacOS ]
+- Code version: (run ``git describe --tags`` to find it)
+- Project/Demo: [ mqtt_demo_mutual_auth | shadow_demo | custom application | etc... ]
+- If your project is a custom application, please add the relevant code snippet(s) in the section titled `"Code to reproduce bug"`.
+
+**Expected behavior**
+A clear description of the expected behavior.
+
+**Screenshots or console output**
+If appropriate, please paste the console output/error log explaining the issue. If possible, include the call stack.
+
+**Steps to reproduce bug**
+    Example:
+      1. "I am using project [ ... ], and have configured with [ ... ]"
+      2. "When run on [ ... ], I observed that [ ... ]"
+
+**Code to reproduce bug**
+The code should be wrapped in the ``cpp`` tag in order to be displayed clearly. For example:
+
+```cpp
+printf("Hello World")
+```
+
+**Additional context**
+Include any additional context relevant to the issue here.
+
+<!-- For general inquiries, please open an issue with the "Type: Question" tag using [this template](.github/ISSUE_TEMPLATE/general_inquiry.md). -->

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature Request
+about: Suggest a new feature for this repository.
+title: "[Feature Request] <replace with your title>"
+labels: Feature Request
+assignees: ''
+
+---
+
+**Is your feature request related to an issue you've encountered? If so, please elaborate.**
+Please provide a clear and concise description of the problem. For example, "I'm always frustrated when [ ... ]".
+
+**Describe the new feature request**
+Provide a clear and concise description of the feature you are proposing, as well as applicable use cases.
+
+**Describe other alternatives you've considered**
+Provide a clear and concise description of any alternatives you've considered.
+
+**Additional context**
+Add any additional information supporting the request here (screenshots, logs, references, etc.).

.github/ISSUE_TEMPLATE/general_inquiry.md

@@ -0,0 +1,34 @@
+---
+name: General Inquiry
+about: Generic issue for initiating discussion on any amazon-freertos topic (ex. questions,
+  clarifications, concerns, etc.).
+title: "[General] <replace with your title>"
+labels: 'Type: Question'
+assignees: ''
+
+---
+
+**Briefly summarize the issue being raised**
+Please describe the topic requiring attention in this issue, as well some background on its current status.
+
+**Describe the desired outcome**
+Identify the intended result of further discussion and eventual resolution of this issue.
+
+**System information**
+- Hardware board: [ ... ]
+- IDE used: [ ... ]
+- Operating System: [ Windows | Linux | MacOS ]
+- Code version: (run ``git describe --tags`` to find it)
+- Project/Demo: [ mqtt_demo_mutual_auth | shadow_demo | custom application | etc... ]
+- If your project is a custom application, please add the relevant code snippet(s) in the section titled `"Code/Steps to reproduce the current status"`.
+
+**References**
+Provide any screenshots, logs, etc. that may assist in providing a better understanding of the highlighted issue.
+
+**Code/Steps to reproduce the current status**
+If applicable, provide concrete instructions or the relevant code snippet(s) for reproducing the current status. Code should be wrapped in the ``cpp`` tag in order to be displayed clearly. For example:
+```cpp
+printf("Hello World")
+```
+**Additional context**
+Add any remaining information not mentioned in the previous responses.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,15 @@
+<!--- Title -->
+
+Description
+-----------
+<!--- Describe your changes in detail -->
+
+Checklist:
+----------
+<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
+<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
+- [ ] I have tested my changes. No regression in existing tests.
+- [ ] My code is Linted.
+
+
+By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.