Skip to content

Latest commit

 

History

History
30 lines (22 loc) · 1.37 KB

CONTRIBUTING.md

File metadata and controls

30 lines (22 loc) · 1.37 KB
Raw

Contribution guide

We appreciate your thought to contribute to open source. ❤️ We want to make contributing as easy as possible. You are welcome to:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features

We Use Github Flow, So All Code Changes Happen Through Pull Requests

Pull requests are the best way to propose changes to the codebase (we use Github Flow). We actively welcome your pull requests:

  1. Fork the repo and create your branch from master.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.
  6. Issue that pull request!

Coding Style

We use the Terraform Style conventions. They are enforced with ci scripts.

Documentation

The README.md in the root is generated by a manual script in ci/bin/autodocs.sh. The script generate the variable tables, merge the in the README.md file based on the file in the _docs folder.

Testing

No automated tests are available. The example directory takes care of a few scenario's.

License

By contributing, you agree that your contributions will be licensed under its MIT License.