1*3c7ae9deSAndroid Build Coastguard Worker# Contributing Guidelines 2*3c7ae9deSAndroid Build Coastguard Worker 3*3c7ae9deSAndroid Build Coastguard WorkerThank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional 4*3c7ae9deSAndroid Build Coastguard Workerdocumentation, we greatly value feedback and contributions from our community. 5*3c7ae9deSAndroid Build Coastguard Worker 6*3c7ae9deSAndroid Build Coastguard WorkerPlease read through this document before submitting any issues or pull requests to ensure we have all the necessary 7*3c7ae9deSAndroid Build Coastguard Workerinformation to effectively respond to your bug report or contribution. 8*3c7ae9deSAndroid Build Coastguard Worker 9*3c7ae9deSAndroid Build Coastguard Worker 10*3c7ae9deSAndroid Build Coastguard Worker## Reporting Bugs/Feature Requests 11*3c7ae9deSAndroid Build Coastguard Worker 12*3c7ae9deSAndroid Build Coastguard WorkerWe welcome you to use the GitHub issue tracker to report bugs or suggest features. 13*3c7ae9deSAndroid Build Coastguard Worker 14*3c7ae9deSAndroid Build Coastguard WorkerWhen filing an issue, please check [existing open](https://github.com/awslabs/aws-crt-java/issues), or [recently closed](https://github.com/awslabs/aws-crt-java/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), issues to make sure somebody else hasn't already 15*3c7ae9deSAndroid Build Coastguard Workerreported the issue. Please try to include as much information as you can. Details like these are incredibly useful: 16*3c7ae9deSAndroid Build Coastguard Worker 17*3c7ae9deSAndroid Build Coastguard Worker* A reproducible test case or series of steps 18*3c7ae9deSAndroid Build Coastguard Worker* The version of our code being used 19*3c7ae9deSAndroid Build Coastguard Worker* Any modifications you've made relevant to the bug 20*3c7ae9deSAndroid Build Coastguard Worker* Anything unusual about your environment or deployment 21*3c7ae9deSAndroid Build Coastguard Worker 22*3c7ae9deSAndroid Build Coastguard Worker 23*3c7ae9deSAndroid Build Coastguard Worker## Contributing via Pull Requests 24*3c7ae9deSAndroid Build Coastguard WorkerContributions via pull requests are much appreciated. Before sending us a pull request, please ensure that: 25*3c7ae9deSAndroid Build Coastguard Worker 26*3c7ae9deSAndroid Build Coastguard Worker1. You are working against the latest source on the *main* branch. 27*3c7ae9deSAndroid Build Coastguard Worker2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already. 28*3c7ae9deSAndroid Build Coastguard Worker3. You open an issue to discuss any significant work - we would hate for your time to be wasted. 29*3c7ae9deSAndroid Build Coastguard Worker 30*3c7ae9deSAndroid Build Coastguard WorkerTo send us a pull request, please: 31*3c7ae9deSAndroid Build Coastguard Worker 32*3c7ae9deSAndroid Build Coastguard Worker1. Fork the repository. 33*3c7ae9deSAndroid Build Coastguard Worker2. 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. 34*3c7ae9deSAndroid Build Coastguard Worker3. Ensure local tests pass. 35*3c7ae9deSAndroid Build Coastguard Worker4. Commit to your fork using clear commit messages. 36*3c7ae9deSAndroid Build Coastguard Worker5. Send us a pull request, answering any default questions in the pull request interface. 37*3c7ae9deSAndroid Build Coastguard Worker6. Wait for a repository collaborator to look at your pull request, run the automated tests, and review. If additional changes or discussion is needed, a collaborator will get back to you, so please stay involved in the conversation. 38*3c7ae9deSAndroid Build Coastguard Worker * Note: pull requests from forks will not run the automated tests without collaborator involvement for security reasons. If you make a pull request and see that the tests are pending, this is normal and expected. 39*3c7ae9deSAndroid Build Coastguard Worker 40*3c7ae9deSAndroid Build Coastguard WorkerGitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and 41*3c7ae9deSAndroid Build Coastguard Worker[creating a pull request](https://help.github.com/articles/creating-a-pull-request/). 42*3c7ae9deSAndroid Build Coastguard Worker 43*3c7ae9deSAndroid Build Coastguard Worker### Formatting Changes 44*3c7ae9deSAndroid Build Coastguard Worker 45*3c7ae9deSAndroid Build Coastguard WorkerAutomation will reject submissions that do not conform to the project's source formatting rules. To correct any formatting problems run `git-clang-format` before submitting your PR. 46*3c7ae9deSAndroid Build Coastguard Worker 47*3c7ae9deSAndroid Build Coastguard Worker## Finding contributions to work on 48*3c7ae9deSAndroid Build Coastguard WorkerLooking 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-java/labels/help%20wanted) issues is a great place to start. 49*3c7ae9deSAndroid Build Coastguard Worker 50*3c7ae9deSAndroid Build Coastguard Worker 51*3c7ae9deSAndroid Build Coastguard Worker## Code of Conduct 52*3c7ae9deSAndroid Build Coastguard WorkerThis project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct). 53*3c7ae9deSAndroid Build Coastguard WorkerFor more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact 54*3c7ae9deSAndroid Build Coastguard Worker[email protected] with any additional questions or comments. 55*3c7ae9deSAndroid Build Coastguard Worker 56*3c7ae9deSAndroid Build Coastguard Worker 57*3c7ae9deSAndroid Build Coastguard Worker## Security issue notifications 58*3c7ae9deSAndroid Build Coastguard WorkerIf 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. 59*3c7ae9deSAndroid Build Coastguard Worker 60*3c7ae9deSAndroid Build Coastguard Worker 61*3c7ae9deSAndroid Build Coastguard Worker## Licensing 62*3c7ae9deSAndroid Build Coastguard Worker 63*3c7ae9deSAndroid Build Coastguard WorkerSee the [LICENSE](https://github.com/awslabs/aws-crt-java/blob/main/LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution. 64*3c7ae9deSAndroid Build Coastguard Worker 65*3c7ae9deSAndroid Build Coastguard WorkerWe may ask you to sign a [Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes. 66