Skip to content

Latest commit

 

History

History
36 lines (21 loc) · 2.36 KB

CONTRIBUTING.md

File metadata and controls

36 lines (21 loc) · 2.36 KB
Raw

Contributing

Thank you for your interest in this project!

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

  1. Reporting an issue or making a feature request here.
  2. 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

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

Requirements

Pull requests have to meet the following requirements:

  1. Tests: Code changes need to be tested with code and tests being located in the same folder (see packages doc and print for examples). Make sure that your tests pass using make test.

  2. Documentation: Pull requests need to update the documentation together with the code change.

  3. 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.

  4. Code Style: Use gofmt to format your code. If useful, include code comments to support your intentions.

Additional Resources