Skip to content

Latest commit

 

History

History
116 lines (86 loc) · 6.74 KB

CONTRIBUTING.md

File metadata and controls

116 lines (86 loc) · 6.74 KB
Raw

Contributing to the CLI

Development Setup

Environment

  • Make sure you are using the latest major version of Go (run go version to check).
  • Fork the repository.
  • Clone your forked repository into your $GOPATH (run go env GOPATH to find out)
    • git clone [email protected]:<user>/aws/amazon-ecs-cli $GOPATH/src/github.com/aws/amazon-ecs-cli
    • NOTE: replace <user> with your Github username.
  • Turn off Go modules with export GO111MODULE=off since we use dep to manage dependencies. Make sure you have version 0.5.4 of dep (installation instructions here). You can also run make generate-deps to install the latest version of dep as well as other tools.

Set upstream

From the repository root run:

git remote add upstream [email protected]:aws/amazon-ecs-cli

git fetch upstream

Building

From $GOPATH/src/github.com/aws/amazon-ecs-cli:

  • Run make (This creates a standalone executable in the bin/local directory).

From $GOPATH/src/github.com/aws/amazon-ecs-cli/ecs-cli:

  • run dep ensure. This will download dependencies specified in the Gopkg.lock by default in $GOPATH/pkg/dep/sources.
  • NOTE: dep ensure puts the dependencies in a detached HEAD state. It also deletes any unused vendor files (includes running dep prune, as of dep 0.4.0)

Adding/updating new dependencies

  • We use dep to manage dependencies. Make sure you have version 0.5.4 of dep (installation instructions here).
  • To add a dependency, run dep ensure -add <your_package>.
  • To update a dependency, run dep ensure -update<your_package>.

Generating mocks/licenses

  • From $GOPATH/src/github.com/aws/amazon-ecs-cli/, run make generate. This will look for all files named generate_mock.go in the ecs-cli/modules directory and call the scripts/mockgen.sh script, which is a wrapper for the mockgen command.
  • NOTE: make generate will also regenerate the license via scripts/license.sh.

Cross-compiling

The make docker-build target builds standalone amd64 executables for Darwin and Linux. The output will be in bin/darwin-amd64 and bin/linux-amd64, respectively.

If you have set up the appropriate bootstrap environments, you may also directly run the make supported-platforms target to create standalone amd64 executables for the Darwin and Linux platforms.

Testing

  • To run unit tests, run make test from $GOPATH/src/github.com/aws/amazon-ecs-cli.

Contributing code

  • Please check the existing issues and FAQ to see if your feedback has already been reported.

  • Let us know if you are interested in working on an issue by leaving a comment on the issue in GitHub. This helps avoid multiple people unknowingly working on the same issue.

  • If you would like to propose a new feature, please open an issue on GitHub with a detailed description. This enables us to collaborate on the feature design more easily and increases the chances that your feature request will be accepted.

  • New features should include full test coverage.

  • All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult GitHub Help for more information on using pull requests.

  • Please submit any PRs against the mainline branch.

  • For any PR where you're updating Gopkg.toml, make sure to run dep ensure && dep prune and commit all changes to vendor as a separate commit.

Amazon Open Source Code of Conduct

This code of conduct provides guidance on participation in Amazon-managed open source communities, and outlines the process for reporting unacceptable behavior. As an organization and community, we are committed to providing an inclusive environment for everyone. Anyone violating this code of conduct may be removed and banned from the community.

Our open source communities endeavor to:

  • Use welcoming and inclusive language;
  • Be respectful of differing viewpoints at all times;
  • Accept constructive criticism and work together toward decisions;
  • Focus on what is best for the community and users.

Our Responsibility. As contributors, members, or bystanders we each individually have the responsibility to behave professionally and respectfully at all times. Disrespectful and unacceptable behaviors include, but are not limited to: The use of violent threats, abusive, discriminatory, or derogatory language;

  • Offensive comments related to gender, gender identity and expression, sexual orientation, disability, mental illness, race, political or religious affiliation;
  • Posting of sexually explicit or violent content;
  • The use of sexualized language and unwelcome sexual attention or advances;
  • Public or private harassment of any kind;
  • Publishing private information, such as physical or electronic address, without permission;
  • Other conduct which could reasonably be considered inappropriate in a professional setting;
  • Advocating for or encouraging any of the above behaviors.

Enforcement and Reporting Code of Conduct Issues. Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting [email protected]. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances.

Attribution. This code of conduct is based on the template established by the TODO Group and the Scope section from the Contributor Covenant version 1.4.

Licensing

The Amazon ECS CLI is released under an Apache 2.0 license. Any code you submit will be released under that license.

For significant changes, we may ask you to sign a Contributor License Agreement.