Skip to content

Latest commit

 

History

History
59 lines (38 loc) · 1.73 KB

CONTRIBUTING.md

File metadata and controls

59 lines (38 loc) · 1.73 KB
Raw

Contributing

  1. Sign one of the contributor license agreements below.

  2. Install Go.

  3. Clone the repo:

    git clone https://github.com/GoogleCloudPlatform/aactl.git

  4. Change into the checked out source:

    cd aactl

  5. Fork the repo.

  6. Set your fork as a remote:

    git remote add fork https://github.com/GITHUB_USERNAME/golang-samples.git

  7. Make changes and commit to your fork. Initial commit messages should follow the Conventional Commits style.

  8. Send a pull request with your changes.

  9. A maintainer will review the pull request and make comments. Prefer adding additional commits over amending and force-pushing since it can be difficult to follow code reviews when the commit history changes. Commits will be squashed when they're merged.

Testing

Before submitting PR, make sure the unit tests pass:

make test

And that there are no Go or YAML linting errors:

make lint

Contributor License Agreements

Before we can accept your pull requests you'll need to sign a Contributor License Agreement (CLA):

  • If you are an individual writing original source code and you own the intellectual property, then you'll need to sign an individual CLA.
  • If you work for a company that wants to allow you to contribute your work, then you'll need to sign a corporate CLA.

You can sign these electronically (just scroll to the bottom). After that, we'll be able to accept your pull requests.