Files
hunfabric/CONTRIBUTING.md
arsenyspb ece8c0896f Update CONTRIBUTING.md
Suggest change of wording related to `terraform format`: should be done from the top, recursively, and after `pytest` step, because fixtures are also going to be checked for linting during PR.
2021-12-15 18:41:51 +08:00

763 B

Contributing

We welcome any contributions on bugs, or feature requests you would like to submit!

The basic process is pretty simple:

  • Fork the Project
  • Create your Feature Branch
    git checkout -b feature/AmazingFeature
  • Commit your Changes
    git commit -m 'Add some AmazingFeature
  • Make sure tests pass!
    pytest # in the root folder
  • Make sure Terraform linting is ok (hint: terraform fmt -recursive in the root folder)
  • Make sure any changes to variables and outputs are reflected in READMEs
    ./tools/tfdoc.py [changed folder]
  • Push to the Branch
    git push origin feature/AmazingFeature
  • Open a Pull Request

When implementing your new feature, please follow our core design principles.