We as members, contributors, and leaders pledge to make participation in our

community a harassment-free experience for everyone, regardless of age, body

size, visible or invisible disability, ethnicity, sex characteristics, gender

identity and expression, level of experience, education, socio-economic status,

nationality, personal appearance, race, religion, or sexual identity

and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,

diverse, inclusive, and healthy community.

Examples of behavior that contributes to a positive environment for our

community include:

* Demonstrating empathy and kindness toward other people

* Being respectful of differing opinions, viewpoints, and experiences

* Giving and gracefully accepting constructive feedback

* Accepting responsibility and apologizing to those affected by our mistakes,

and learning from the experience

* Focusing on what is best not just for us as individuals, but for the

overall community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or

advances of any kind

* Trolling, insulting or derogatory comments, and personal or political attacks

* Public or private harassment

* Publishing others' private information, such as a physical or email

address, without their explicit permission

* Other conduct which could reasonably be considered inappropriate in a

professional setting

Community leaders are responsible for clarifying and enforcing our standards of

acceptable behavior and will take appropriate and fair corrective action in

response to any behavior that they deem inappropriate, threatening, offensive,

or harmful.

Community leaders have the right and responsibility to remove, edit, or reject

comments, commits, code, wiki edits, issues, and other contributions that are

not aligned to this Code of Conduct, and will communicate reasons for moderation

decisions when appropriate.

This Code of Conduct applies within all community spaces, and also applies when

an individual is officially representing the community in public spaces.

Examples of representing our community include using an official e-mail address,

posting via an official social media account, or acting as an appointed

representative at an online or offline event.

Instances of abusive, harassing, or otherwise unacceptable behavior may be

reported to the community leaders responsible for enforcement at

[email protected].

All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the

reporter of any incident.

Community leaders will follow these Community Impact Guidelines in determining

the consequences for any action they deem in violation of this Code of Conduct:

**Community Impact**: Use of inappropriate language or other behavior deemed

unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing

clarity around the nature of the violation and an explanation of why the

behavior was inappropriate. A public apology may be requested.

**Community Impact**: A violation through a single incident or series

of actions.

**Consequence**: A warning with consequences for continued behavior. No

interaction with the people involved, including unsolicited interaction with

those enforcing the Code of Conduct, for a specified period of time. This

includes avoiding interactions in community spaces as well as external channels

like social media. Violating these terms may lead to a temporary or

permanent ban.

**Community Impact**: A serious violation of community standards, including

sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public

communication with the community for a specified period of time. No public or

private interaction with the people involved, including unsolicited interaction

with those enforcing the Code of Conduct, is allowed during this period.

Violating these terms may lead to a permanent ban.

**Community Impact**: Demonstrating a pattern of violation of community

standards, including sustained inappropriate behavior, harassment of an

individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within

the community.

This Code of Conduct is adapted from the [Contributor Covenant][homepage],

version 2.0, available at

https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

Community Impact Guidelines were inspired by [Mozilla's code of conduct

enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see the FAQ at

https://www.contributor-covenant.org/faq. Translations are available at

https://www.contributor-covenant.org/translations.

LocalStack is a community driven project that aims to help developers emulate AWS services locally, without connecting to any cloud provider! The community version of LocalStack has grown exceptionally and now supports various AWS services, which is detailed on our [feature coverage](https://docs.localstack.cloud/aws/feature-coverage/).

This document serves the need for a guide for contributors to help them understand the overall organization of the LocalStack community projects. As an emerging open-source community, we have a plethora of work that we need to do and complete, and it is not just limited to code.

From a contribution perspective, you can work on writing examples, triaging issues and pull requests, submitting bug fixes, suggesting improvements and making our documentation accessible to more users.

Before submitting any contributions to LocalStack, you should complete the following prerequisties. Having completed and understood the basic philosophy around these steps would make it easier for you to land your first contribution.

LocalStack governs its participants according to the Contributor Covenant [Code of Conduct](CODE_OF_CONDUCT.md). As a contributor, you agree to uphold this code. Please report unacceptable behavior to [[email protected]](mailto:[email protected]).

To contribute code contributions, setting up a development environment is required. Review the [LocalStack developer guide](https://docs.localstack.cloud/developer-guide/) to understand how you can setup the environment and make the desirable changes. It is also recommended to look at our [open issues](https://github.com/localstack/localstack/issues) for better context around contributions we are looking for.

When you submit changes, your submissions are understood to be under the same [Apache 2.0 License](LICENSE) that covers the project. Feel free to contact the maintainers if that's a concern.

We assume that you have already set up the project on your local machine by following up on the official documentation. If you are stuck, do reach out to one of the maintainers to help you out in the process.

Our contribution flow is very straightforward and follows an issue-pull request workflow. The contributors need to fork the repository for having their contributions landed on the project. If you are looking to contribute, we have laid down a series of steps that we would like you to follow.

We would recommend you to go through the **Issues** of the specific project that you would like to contribute to. You can additionally:

- Understand and identify the gaps in the code and documentation.

- Understand the code formatting, stylistic principles and comment format that is being followed.

- Test specific pull requests and the project on your local machine and see if the changes are desirable.

Exploring the issues and pull requests, will give you an idea of how the contribution flow works. Upon finding something to work on, you can either request for the issue to be assigned to you (if someone else has created the Issue) or you can make your own. To ensure that the issue is received positively by the maintainers make sure of the following:

- If you are filing a Bug report, make sure that the report includes all the information that the maintainer needs to reproduce the issue.

- If you are filing a feature request, make sure you pitch in your idea well and it should be constructive.

- Before opening a new issue, make sure a similar one has not already been created or is being worked on by someone else.

To make sure you land a great contribution, we would request you to follow the standard Git & GitHub workflow to know about code collaboration. If you are not already familiar with Git, we would suggest you follow the [official Git documentation](https://git-scm.com/doc).

We would recommend:

- Every Pull Request should have the corresponding issue linked to it.

- Every Pull Request should pass the automated CI checks.

- Every Pull Request should be as atomic as possible.

- Every Pull Request should include a test verifying the new/fixed behavior.

Atomic commits correspond to the smallest, most meaningful change you can make to the code. You can keep your pull request as a draft if you are still working on it. Upon completion, you can mark the pull request is ready to review for further comments and feedback.

After landing your pull request, the maintainers will review it and provide actionable feedback. Don't hesitate to contact the maintainers on the Slack community channels if you are awaiting your first review or you have made all the required changes.

Maintainers expect the comments to be resolved once a review has been completed. You can provide updates if you are still working on it, to help us understand the areas where we can help. After the pull request is reviewed and approved, we would squash all the commits before we officially merge it.

This document is the best practice guide that contains the rules to follow while contributing to LocalStack projects using Git & GitHub.

The basic prerequisites are:

- [GitHub Account](https://github.com/home)

- [Git CLI](https://git-scm.com/)

We also recommend you to authenticate [Git with GitHub using SSH](https://docs.github.com/en/authentication/connecting-to-github-with-ssh).

In your browser, visit: https://github.com/localstack. Find the project that you would like to contribute to and open the appropriate link. In the upper left corner, you will find an option to fork the project. Please click on it to create a fork/copy of the repository on your profile.

- In your terminal, clone the repository by running the command where `your-username` represents your GitHub username while the `project-slug` signifies the name of the project you are cloning.

```sh

git clone https://github.com/<your-username>/<project-slug>/

```

- Enter into the newly created directory by running the following command on your terminal:

```sh

cd <project-slug>

```

- Configure the upstream for your fork so that `git` can sync work from the upstream, by running the following command:

```sh

git remote add upstream <link_of_original_repository>

```

- Check if upstream is configured by running the command:

```sh

git remote -v

```

After you set up your fork, start contributing code, docs and fixes.

- Create a branch on your local machine:

```sh

git checkout <branch-name>

```

- Commit the changes:

```sh

git add <file> <file> ...

git commit -m "relevant commit message"

```

- Push the changes to the remote forked repository.

```sh

git push -u origin <branch-name>

```

You can now create a pull request to get your changes merged into the upstream branch of the specific repository.

<p align="center">

<img src="assets/localstack-readme-banner.svg" alt="LocalStack - A fully functional local cloud stack">

</p>

The purpose of this repository is to host all the community health files for LocalStack. These files serve the purpose of global community files which are applied to all the organizations that don't have their own files.

- [Contributing to LocalStack](CONTRIBUTING.md)

- [LocalStack Contributor Covenant](CODE_OF_CONDUCT.md)

- [Git-GitHub workflow](GIT_GITHUB_WORKFLOW.md)

- [Slack guidelines](SLACK_GUIDELINES.md)

LocalStack community uses Slack for real-time conversations and to communicate across the community. To make sure we are getting the best out of our Slack community, we have a few guidelines in place.

- **Follow our code of conduct**: LocalStack expects all the contributors to uphold the Contributor Covenant [Code of Conduct](CODE_OF_CONDUCT.md).

- **Be nice, be respectful**: Be nice and respectful with all the community members. If someone sounds off, give them the benefit of the doubt and assume they meant well.

- **Use inclusive language**: Be mindful of not using words that are exclusionary in nature and should allow more diverse audience to engage with you.

- **Community support**: For all community support, please use the `community-support` channel. For inquiries about professional and enterprise support, use the `general` channel to express interest.

- **Avoid direct messages**: Slack is about communication and we prefer public messages to be used wherever we can. Please use direct messages for sales, inquiry into licensing and pro support.

Everyone will be automatically added into this channel. Admins will have posting privileges. This is a good place to look out for new releases, features, workshops and webinars!

Everyone will be automatically added into this channel. Everyone will have posting privileges. This is a good place to put your queries, bug reports, issues that you encountered while using LocalStack.

Everyone will be automatically added into this channel. Everyone will have posting privileges. This is a good place to discuss about LocalStack, inquire about sales and pro licensing and more.

Everyone will be automatically added into this channel. Everyone will have posting privileges. We use it for non-work banter and watercool conversation.