Skip to content

Latest commit

 

History

History
60 lines (45 loc) · 2.24 KB

CONTRIBUTING.md

File metadata and controls

60 lines (45 loc) · 2.24 KB
Raw

How to contribute

Contributions are welcome to this repo, but we do have a few guidelines for contributors.

Open an issue and pull request for changes

All submissions, including those from project members, are required to go through review. We use GitHub Pull Requests for this workflow, which should be linked with an issue for tracking purposes. A GitHub action will be run against your PR to ensure code standards have been applied.

pre-commit is used to ensure that all files have consistent formatting and to avoid committing secrets.

  1. Install pre-commit in a virtual python environment or globally: see instructions

  2. Fork and clone this repo

  3. Install pre-commit hook to git

    E.g.

    pip install --upgrade pip pre-commit
pre-commit install

  4. Create a new branch for changes

  5. Execute tests using Makefile

    E.g.

    gmake verify
kitchen list
    Instance                           Driver     Provisioner  Verifier   Transport  Last Action  Last Error
minimal-project-role-local         Terraform  Terraform    Terraform  Ssh        Verified     <None>
random-id-project-role-local       Terraform  Terraform    Terraform  Ssh        Verified     <None>
fixed-id-project-role-local        Terraform  Terraform    Terraform  Ssh        Verified     <None>
minimal-org-role-local             Terraform  Terraform    Terraform  Ssh        Verified     <None>
random-id-org-role-local           Terraform  Terraform    Terraform  Ssh        Verified     <None>
fixed-id-org-role-local            Terraform  Terraform    Terraform  Ssh        Verified     <None>
example-simple-project-role-local  Terraform  Terraform    Terraform  Ssh        Verified     <None>
example-simple-org-role-local      Terraform  Terraform    Terraform  Ssh        Verified     <None>
example-fixed-id-local             Terraform  Terraform    Terraform  Ssh        Verified     <None>

    gmake clean

  6. Commit and push changes for PR

    The hook will ensure that pre-commit will be run against all staged changes during git commit.