Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

For Terraform/IAC MRs: create style guide, code standards, best practices, and definition of done #62

Open
MeltyBot opened this issue Mar 2, 2022 · 1 comment

Comments

@MeltyBot
Copy link

MeltyBot commented Mar 2, 2022

Migrated from GitLab: https://gitlab.com/meltano/handbook/-/issues/68

Originally created by @aaronsteers on 2022-03-02 21:58:21


First raised here: https://gitlab.com/meltano/squared/-/merge_requests/70#note_860678737

For terraform resources, let's create a set of code standards:

guidelines such as:

  • Code matches terraform fmt auto-format output.
  • What docs are expected - inline and in markdown docs - for definition of done?
  • Should we have a top-of-file "docstring" for each .tf file?
  • camel_case vs kebab-case for resource and variable names? I personally favor camel_case but anyway the project currently uses both.
  • Disallow using our own aws account IDs in .tf files. (Replaced by data refs, relative refs, or input vars.)
  • ...
@MeltyBot
Copy link
Author

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants