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.

Sign up for GitHub

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

Jump to bottom

Agree on and document Terraform coding preferences #63

Open
2 tasks
dav3r opened this issue Dec 1, 2021 · 0 comments
Open
2 tasks

Agree on and document Terraform coding preferences #63

dav3r opened this issue Dec 1, 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 need info This issue or pull request requires further information

Comments

@dav3r
Copy link
Member

dav3r commented Dec 1, 2021

💡 Summary

We should come to consensus on various Terraform-related coding/naming conventions and document them.

Motivation and context

In cisagov/cool-assessment-terraform#153 there was some discussion about how to best name Terraform resources that can contain one or multiple instances of that resource. We decided in that PR to pluralize the name of those resources and their related descriptions. If that is our decision, we should document it somewhere and abide by it.

Implementation notes

None

Acceptance criteria

  • Terraform-related coding and/or naming conventions have been documented
  • The above conventions can be applied to our code reviews going forward
@dav3r dav3r 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 need info This issue or pull request requires further information labels Dec 1, 2021
@dav3r dav3r mentioned this issue Dec 1, 2021
Merged
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
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 need info This issue or pull request requires further information
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@dav3r