Skip to content

Latest commit

 

History

History
212 lines (155 loc) · 6.69 KB

CONTRIBUTING.md

File metadata and controls

212 lines (155 loc) · 6.69 KB
Raw

Contributing Guidelines

Thank you for your interest in contributing to our project. Whether it is a bug report, new feature, correction, or additional documentation, we greatly value feedback and contributions from our community.

Please read through this document before submitting any issues or pull requests to ensure we have all the necessary information to effectively respond to your bug report or contribution.

Reporting Bugs/Feature Requests

We welcome you to use the GitHub issue tracker to report bugs or suggest features.

When filing an issue, please check existing open, and recently closed issues to make sure somebody else has not already reported the issue.

Please try to include as much information as you can. Details like these are incredibly useful:

  • A reproducible test case or series of steps
  • The version of our code being used
  • For deployment related bugs, please include the details returned by the following command as executed on the development machine: make report_versions
  • Any modifications you have made relevant to the bug
  • Anything unusual about your environment or deployment

Running tests locally

In order to run the tests locally you need install the development requirements in the python virtual environment that is used.

To ensure test execute consistently, ADF relies on tox.

The easiest way to install and run these tests is to run:

make tox

Alternatively, you can also install the required dependencies in your python virtual environment by running:

pip install -r requirements-dev.txt

To run the tests, simply execute next: tox. This will create a virtual environment managed by tox to run the tests in.

Running linters locally

You need to have NodeJS and Docker installed on your computer to run MegaLinter locally with MegaLinter Runner.

You can run mega-linter-runner without installation by using npx. Make sure to execute this from the root of the repository.

npx mega-linter-runner

Some linters can automatically fix findings by running the command below.

npx mega-linter-runner --fix

Deploy your changes

  1. To deploy your changes, make sure to commit them in your local repository first.

  2. If you are working on your own fork, make sure to add the upstream repository as a remote and fetch its tags. As these tags are used to generate the version number. You do this by:

    git remote add upstream https://github.com/awslabs/aws-deployment-framework
git fetch upstream --tags

  3. Once you committed and optionally fetched the upstream repo tags, follow the installation guide to deploy them into your management account.

Contributing via Pull Requests

Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:

  1. You are working against the latest source on the master branch.
  2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
  3. You open an issue to discuss any significant work - we would hate for your time to be wasted.

To send us a pull request, please:

  1. Fork the repository.
  2. 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.
  3. Make sure your editor is configured to use editorconfig, this helps maintain consistent coding styles and prevents linter findings later.
  4. Ensure local tests and linters pass.
  5. Commit to your fork using clear commit messages.
  6. Send us a pull request, answering any default questions in the pull request interface.
  7. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.

GitHub provides additional document on forking a repository and creating a pull request.

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' issues is a great place to start.

Use of examples

To ensure that email addresses or account ids are not exposed by accident, it is recommended to use one of the following examples instead:

In case you want to specify an example email address, please make use of one of the following email addresses:

  • jane@example.com
  • john@example.com
  • janes_team@example.com
  • Or another @example.com
  • For tests that could potentially create accounts (if mocks failed to work), please use test@amazon.com instead.

When you want to write documentation/tests and need an example account id, the following account ids may be used:

  • 111111111111
  • 222222222222
  • ... to ...
  • 999999999999
  • or to show the length more easily:
  • 012345678910
  • 012345671234
  • 123456789012

Resolving Build and deployment issues

Please capture the environment the build/deployment issue occurs in:

make version_report

Before you report an issue, please try again after cleaning the environment:

make clean

Possibly, this issue is fixed already, please update your Makefile and try again after:

make update_makefile

If that did not resolve the issue, please try running:

make clean deps_build

Or download an older version of the Makefile by running:

make UPDATE_VERSION=make/2.0 update_makefile

Code of Conduct

This project has adopted the Amazon Open Source Code of Conduct. For more information see the 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.

Please do not create a public GitHub issue.

Licensing

See the LICENSE file for our project's licensing. We will ask you to confirm the licensing of your contribution.