Skip to content

Latest commit

 

History

History
145 lines (96 loc) · 4.19 KB

CONTRIBUTING.rst

File metadata and controls

145 lines (96 loc) · 4.19 KB
Raw

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/compose-x/ecs_composex/issues, or join us on Slack

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Submit your use-case to the test-suite

In the repository, under use-cases, we have many variations of docker-compose files that will be used to test each individual ECS Compose-X module, sometimes merged together. If you have been using ECS Compose-X and want to make sure that future versions will maintain compatibility, please feel free to submit your compose file and have it added to the test suite!

Note

If you do submit your use-case, keep in mind not to use your own resource ARNs and otherwise account specific configuration. If you defined a domain name, x-route53.Lookup in your file, you can change it with to bdd-testing.compose-x.io instead so that all your settings (Records etc.)

Report Bugs

Report bugs at https://github.com/compose-x/ecs_composex/issues.

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.

Write Documentation

ECS-ComposeX could always use more documentation, whether as part of the official ECS-ComposeX docs, in docstrings, or even on the web in blog posts, articles, and such.

Get Started!

Ready to contribute? Here's how to set up ecs_composex for local development.

  1. Fork the ecs_composex repo on GitHub.

  2. Clone your fork locally:

    $ git clone [email protected]:your_name_here/ecs_composex.git

  3. Install your local copy into a virtualenv. Assuming you have python3 and pip installed, this is how you set up your fork for local development:

    $ python -m venv venv
$ source venv/bin/activate
$ cd ecs_composex/
$ pip install poetry
$ poetry install

  4. Create a branch for local development:

    $ git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally.

  5. When you're done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

    $ make lint
$ make conform
$ make coverage

    To get flake8 and tox, just pip install them into your virtualenv.

  6. Commit your changes and push your branch to GitHub:

    $ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

  7. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests. Use make coverage to run both tests and coverage analysis.
  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst of the module.

Tips

To run a subset of tests:

$ make test
$ make coverage

Deploying

A reminder for the maintainers on how to deploy. Make sure all your changes are committed (including an entry in HISTORY.rst). Then run:

$ tbump --no-push major.minor.patch
$ git push
$ git push --tags

AWS CodeBuild will build and run the tests