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

Decide on Style Guidelines for Terraform Code #50

Open
2 tasks
mcdonnnj opened this issue May 6, 2021 · 0 comments
Open
2 tasks

Decide on Style Guidelines for Terraform Code #50

mcdonnnj opened this issue May 6, 2021 · 0 comments
Labels
documentation This issue or pull request improves or adds to documentation improvement This issue or pull request will add or improve functionality, maintainability, or ease of use

Comments

@mcdonnnj
Copy link
Member

mcdonnnj commented May 6, 2021

💡 Summary

We should have a style guide for Terraform (HCL) code just as we do for Python.

Motivation and context

It's currently more just team lore as to what the preferences for how we write Terraform code. This include things like ordering statements, common permissions for common policies, and preferred naming. This will not only help the team write consistent Terraform code, but will also help in our collaboration with other developers who want to integrate with our Terraform-defined environments.

Implementation notes

This should be a new languages/terraform or languages/hcl (that may cause confusion because Packer has started moving to HCL and would likely want its own style guide). It can just contain some core elements at first and will give us a go-to place to add information as we develop further guidelines internally.

Acceptance criteria

  • PR is created
  • Everyone signs off on the PR
@mcdonnnj mcdonnnj added documentation This issue or pull request improves or adds to documentation improvement This issue or pull request will add or improve functionality, maintainability, or ease of use labels May 6, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This issue or pull request improves or adds to documentation improvement This issue or pull request will add or improve functionality, maintainability, or ease of use
Projects
None yet
Development

No branches or pull requests

1 participant