Skip to content
Documentation

GitHub Repositories Naming Conventions | Module

Loading...

Introduction

Consistent and meaningful repository names are crucial for maintaining an organized and easily navigable codebase. The following conventions provide guidelines for naming Terraform AWS module repositories:

Module Naming Examples

The structure of the repository name should follow tf-aws-modules-<service>. Here are some examples:

Good Examples (AWS Modules):

  • tf-aws-modules-vpc (AWS VPC module)
  • tf-aws-modules-ec2 (AWS EC2 module)
  • tf-aws-modules-s3 (AWS S3 module)

Avoid Examples (AWS Modules):

  • tf-aws_vpc (underscore instead of dash)
  • Terraform-AWS-VPC (mixed case)
  • tf-aws-vpc-module (redundant “module” in the name)

Conclusion

By following these naming conventions, you can ensure that your Terraform AWS module repositories are consistent, descriptive, and easy to navigate. This will help you and your team maintain a well-organized codebase and streamline the development process.