Contributing

Thank you for your interest in this project!

We use GitHub Issues for trackings issues and features. You can make a contribution by:

Reporting an issue or making a feature request here.
Contributing code to this project by fixing an issue or adding a new feature (see below).

Before contributing a new feature, please discuss its suitability with the project maintainers in an issue first. Thanks!

Contribution Process

Fork and git clone terraform-docs.
Create a new git branch from the master branch where you develop your changes.
Create a Pull Request for your contribution by following the instructions in the pull request template here.
Perform a code review with the project maintainers on the pull request. We may suggest changes, improvements or alternatives.
Once approved, your code will be merged into master and your name will be included in AUTHORS.

Pull requests have to meet the following requirements:

Tests: Code changes need to be tested with code and tests being located in the same folder (see packages format for example). Make sure that your tests pass using make test.
Documentation: Pull requests need to update the Formats Guide and if need be the main README together with the code change. You can generate the format guides by using make docs.
Commits: Commits should be as small as possible while ensuring that each commit compiles and passes tests independently. Write good commit messages. If needed, squash your commits prior to submission.
Code Style: We use goimports which wrappes around gofmt to keep the code in unified format. You can use make goimports to install and make fmt to format your code. If useful, include code comments to support your intentions. Make sure your code doesn't have issues with make checkfmt and make lint before submission.