# Amplify CI Support Contributing Guide

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. The following is our contribution guide, which we hope you will read through carefully prior to submitting a pull-request (PR) or issue. In the event that our guide is not up to date, feel free to let us know by opening an issue (or even better, submit a PR with your proposed corrections.


- [Our Design](#our-design)
- [Getting Started](#getting-started)
- [Testing](#testing)
- [Tools](#tools)
- [Debugging](#debugging)
- [Pull Requests](#pull-requests)
  - [Pull Request Checklist](#pull-request-checklist)
  - [Step 1: Open Issue](#step-1-open-issue)
  - [Step 2: Design (optional)](#step-2-design-optional)
  - [Step 3: Fork The Repo](#step-3-fork-the-repo)
  - [Step 4: Work your Magic](#step-3-work-your-magic)
  - [Step 5: Commit](#step-4-commit)
  - [Step 6: Pull Request](#step-5-pull-request)
  - [Step 7: Merge](#step-6-merge)
- [Troubleshooting](#troubleshooting)
- [Related Repositories](#related-repositories)
- [Finding Contributions](#finding-contributions-to-work-on)
- [Code of Conduct](#code-of-conduct)
- [Security Issue Notifications](#security-issue-notifications)
- [Licensing](#licensing)


## Our Design

TBD


## Getting Started

TBD


## Testing

TBD


## Tools

TBD


## Debugging

TBD


## Pull Requests

TBD


### Pull Request Checklist

TBD


### Step 1: Open Issue

TBD


### Step 2: Design (optional)

TBD


### Step 3: Fork The Repo

TBD


### Step 4: Work your Magic

TBD


### Step 5: Commit

TBD


### Step 6: Pull Request

TBD


### Step 7: Merge

TBD


## Troubleshooting

TBD


## Related Repositories

This project supports the Amplify Framework, which runs on Android,
iOS, and numerous JavaScript-based web platforms.

1. [AWS Amplify for Android](https://github.com/aws-amplify/amplify-android)
1. [AWS Amplify for iOS](https://github.com/aws-amplify/amplify-ios)
2. [AWS Amplify for JavaScript](https://github.com/aws-amplify/amplify-js)

It also supports the underlying functionality provided by AWS SDKs. AWS SDKs are a
toolkit for interacting with AWS backend resources.

1. [AWS SDK for Android](https://github.com/aws-amplify/aws-sdk-android)
2. [AWS SDK for iOS](https://github.com/aws-amplify/aws-sdk-ios)
3. [AWS SDK for JavaScript](https://github.com/aws/aws-sdk-js)


## 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/aws-amplify/amplify-ios/labels/help%20wanted) or ['good first'](https://github.com/aws-amplify/amplify-ios/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) 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.


## 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](https://github.com/aws-amplify/amplify-ios/blob/main/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.