1# Contributing Guidelines 2 3Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional 4documentation, we greatly value feedback and contributions from our community. 5 6Please read through this document before submitting any issues or pull requests to ensure we have all the necessary 7information to effectively respond to your bug report or contribution. 8 9 10## Reporting Bugs/Feature Requests 11 12We welcome you to use the GitHub issue tracker to report bugs or suggest features. 13 14When filing an issue, please check [existing open](https://github.com/awslabs/aws-crt-cpp/issues), or [recently closed](https://github.com/awslabs/aws-crt-cpp/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), issues to make sure somebody else hasn't already 15reported 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 24Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that: 25 261. You are working against the latest source on the *main* branch. 272. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already. 283. You open an issue to discuss any significant work - we would hate for your time to be wasted. 29 30To send us a pull request, please: 31 321. Fork the repository. 332. 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. 343. Ensure local tests pass. 354. Commit to your fork using clear commit messages. 365. Send us a pull request, answering any default questions in the pull request interface. 376. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation. 38 39GitHub 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 44Looking 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/awslabs/aws-crt-cpp/labels/help%20wanted) issues is a great place to start. 45 46 47## Code of Conduct 48This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct). 49For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact 50opensource-codeofconduct@amazon.com with any additional questions or comments. 51 52 53## Security issue notifications 54If 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 59See the [LICENSE](https://github.com/awslabs/aws-crt-cpp/blob/main/LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution. 60 61We may ask you to sign a [Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes. 62