forked from FreeRTOS/coreHTTP
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
54 changed files
with
820 additions
and
801 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,63 +1,90 @@ | ||
| # 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. | ||
| 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](https://github.com/FreeRTOS/coreHTTP/issues), or [recently closed](https://github.com/FreeRTOS/coreHTTP/issues?q=is%3Aissue+is%3Aclosed), 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: | ||
| We welcome you to use the GitHub issue tracker to report bugs or suggest | ||
| features. | ||
|
|
||
| * 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 | ||
| When filing an issue, please check | ||
| [existing open](https://github.com/FreeRTOS/coreHTTP/issues), or | ||
| [recently closed](https://github.com/FreeRTOS/coreHTTP/issues?q=is%3Aissue+is%3Aclosed), | ||
| 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. | ||
| 1. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already. | ||
| 1. You open an issue to discuss any significant work - we would hate for your time to be wasted. | ||
| 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. | ||
| 1. You check existing open, and recently merged, pull requests to make sure | ||
| someone else hasn't addressed the problem already. | ||
| 1. 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. Fork the repository. | ||
| 1. 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. | ||
| 1. Ensure that your contributions conform to the [style guide](https://docs.aws.amazon.com/embedded-csdk/202011.00/lib-ref/docs/doxygen/output/html/guide_developer_styleguide.html). | ||
| 1. Format your code with uncrustify, using the config available in [FreeRTOS/CI-CD-Github-Actions](https://github.com/FreeRTOS/CI-CD-Github-Actions/blob/main/formatting/uncrustify.cfg). | ||
| 1. 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. | ||
| 1. Ensure that your contributions conform to the | ||
| [style guide](https://docs.aws.amazon.com/embedded-csdk/202011.00/lib-ref/docs/doxygen/output/html/guide_developer_styleguide.html). | ||
| 1. Format your code with uncrustify, using the config available in | ||
| [FreeRTOS/CI-CD-Github-Actions](https://github.com/FreeRTOS/CI-CD-Github-Actions/blob/main/formatting/uncrustify.cfg). | ||
| 1. Ensure local tests pass. | ||
| 1. Commit to your fork using clear commit messages. | ||
| 1. Send us a pull request, answering any default questions in the pull request interface. | ||
| 1. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation. | ||
| 1. Send us a pull request, answering any default questions in the pull request | ||
| interface. | ||
| 1. 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 | ||
| 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/). | ||
|
|
||
|
|
||
| ## 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'](https://github.com/FreeRTOS/coreHTTP/labels?q=help+wanted) issues is a great place to start. | ||
|
|
||
| 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'](https://github.com/FreeRTOS/coreHTTP/labels?q=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 | ||
| opensource-codeofconduct@amazon.com with any additional questions or comments. | ||
|
|
||
| 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 | ||
| opensource-codeofconduct@amazon.com 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](https://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue. | ||
|
|
||
| If you discover a potential security issue in this project we ask that you | ||
| notify AWS/Amazon Security via our | ||
| [vulnerability reporting page](https://aws.amazon.com/security/vulnerability-reporting/). | ||
| Please do **not** create a public github issue. | ||
|
|
||
| ## Licensing | ||
|
|
||
| See the [LICENSE](../LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution. | ||
| See the [LICENSE](../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)](https://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes. | ||
| We may ask you to sign a | ||
| [Contributor License Agreement (CLA)](https://en.wikipedia.org/wiki/Contributor_License_Agreement) | ||
| for larger changes. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,21 +1,25 @@ | ||
| <!--- Title --> | ||
|
|
||
| Description | ||
| ----------- | ||
| ## Description | ||
|
|
||
| <!--- Describe your changes in detail. --> | ||
|
|
||
| Test Steps | ||
| ----------- | ||
| ## Test Steps | ||
|
|
||
| <!-- Describe the steps to reproduce. --> | ||
|
|
||
| Checklist: | ||
| ---------- | ||
| ## 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. | ||
| - [ ] I have modified and/or added unit-tests to cover the code changes in this Pull Request. | ||
| - [ ] I have modified and/or added unit-tests to cover the code changes in this | ||
| Pull Request. | ||
|
|
||
| ## Related Issue | ||
|
|
||
| Related Issue | ||
| ----------- | ||
| <!-- If any, please provide issue ID. --> | ||
| By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice. | ||
|
|
||
| By submitting this pull request, I confirm that you can use, modify, copy, and | ||
| redistribute this contribution, under the terms of your choice. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.