Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
* @viren-nadkarni

**/models.py @localstack/phoenix
40 changes: 3 additions & 37 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,5 @@
# Table of Contents
If you find a bug within Moto, please contribute directly to the [Moto project](https://github.com/getmoto/moto).

- [Contributing code](#contributing-code)
- [Development Guide](#development-guide)
* [TLDR](#tldr)
* [Linting](#linting)
- [Maintainers](#maintainers)
If you find a bug in LocalStack or Moto-Ext, please report this to our [support team](https://docs.localstack.cloud/aws/getting-started/help-support/).

# Contributing code

Moto has a [Code of Conduct](https://github.com/getmoto/moto/blob/master/CODE_OF_CONDUCT.md), you can expect to be treated with respect at all times when interacting with this project.

# Development Guide
Please see our documentation for information on how to contribute:
https://docs.getmoto.org/en/latest/docs/contributing

## TLDR

Moto has a [Makefile](./Makefile) which has some helpful commands for getting set up.
You should be able to run `make init` to install the dependencies and then `make test` to run the tests.

*NB. On first run, some tests might take a while to execute, especially the Lambda ones, because they may need to download a Docker image before they can execute.*

## Linting

Ensure that the correct version of ruff is installed (see `requirements-dev.txt`). Different versions of ruff will return different results.
Run `make lint` to verify whether your code confirms to the guidelines.
Use `make format` to automatically format your code, if it does not conform to `ruff`'s rules.


# Maintainers

## Releasing a new version of Moto

* Ensure the CHANGELOG document mentions the new release, and lists all significant changes.
* Go to the dedicated [Release Action](https://github.com/getmoto/moto/actions/workflows/release.yml) in our CI
* Click 'Run workflow' on the top right
* Provide the version you want to release
* That's it - everything else is automated.
Contributions to this codebase will be reviewed on a case-by-case basis to determine whether they are applicable to LocalStack.
34 changes: 2 additions & 32 deletions ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,3 @@
## Reporting Bugs
This issue tracker is not actively monitored.

Please be aware of the following things when filing bug reports:

1. Avoid raising duplicate issues. *Please* use the GitHub issue search feature
to check whether your bug report or feature request has been mentioned in
the past.
2. When filing bug reports about exceptions or tracebacks, please include the
*complete* traceback. Partial tracebacks, or just the exception text, are
not helpful.
3. Make sure you provide a suitable amount of information to work with. This
means you should provide:

- Guidance on **how to reproduce the issue**. Ideally, this should be a
*small* code sample that can be run immediately by the maintainers.
Failing that, let us know what you're doing, how often it happens, what
environment you're using, etc. Be thorough: it prevents us needing to ask
further questions.
- Tell us **what you expected to happen**. When we run your example code,
what are we expecting to happen? What does "success" look like for your
code?
- Tell us **what actually happens**. It's not helpful for you to say "it
doesn't work" or "it fails". Tell us *how* it fails: do you get an
exception? A hang? How was the actual result different from your expected
result?
- Tell us **what version of Moto you're using**, and
**how you installed it**. Tell us whether you're using standalone server
mode or the Python mocks. If you are using the Python mocks, include the
version of boto/boto3/botocore.


If you do not provide all of these things, it will take us much longer to
fix your problem.
If you find a bug in LocalStack or Moto-Ext, please report this to our [support team](https://docs.localstack.cloud/aws/getting-started/help-support/).
Loading