Skip to content

Latest commit

 

History

History
37 lines (25 loc) · 948 Bytes

CONTRIBUTING.md

File metadata and controls

37 lines (25 loc) · 948 Bytes

Contributing

Support is very well appreciated.

One does not need to be a terraform expert to support this project. Topic to be covered could be:

  • Reporting usage issues
  • Reporting cumbersome configruation
  • Reporting typos
  • Reporting bugs
  • Creating guides
  • Analyzing bugs
  • Fixing bugs
  • Writting tests

Documentation

Where to put what

Document as near as possible to the part you are going to add additional information. Good structuring and meaningful variable and function names might reduce the need of creating additional text.

Documentation which is related to the source code should be done either directly in the file or using Markdown.

Furthermore to describe concepts and evaluation results the GitHub Wiki pages should be used.

Markdown

Markdown files have to checked against the "Style Checker".

Style Checker

Use Markdown style formatter: Markdownlint.