https://github.com/excoriate/terraform-registry-module-template
A comprehensive template repository for Terraform modules with best practices and GitHub workflow integrations.
https://github.com/excoriate/terraform-registry-module-template
Last synced: about 1 year ago
JSON representation
A comprehensive template repository for Terraform modules with best practices and GitHub workflow integrations.
- Host: GitHub
- URL: https://github.com/excoriate/terraform-registry-module-template
- Owner: Excoriate
- License: apache-2.0
- Created: 2022-12-29T09:16:13.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-28T12:22:29.000Z (about 1 year ago)
- Last Synced: 2025-03-30T10:29:58.800Z (about 1 year ago)
- Language: Just
- Homepage:
- Size: 399 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
- Roadmap: docs/ROADMAP.md
Awesome Lists containing this project
README
[](https://github.com/Excoriate/terraform-registry-module-template/actions/workflows/pre-commit.yml) [](https://github.com/Excoriate/terraform-registry-module-template/actions/workflows/tf-modules-ci.yaml) [](https://github.com/Excoriate/terraform-registry-module-template/actions/workflows/go-linter.yaml)
---
## Terraform Registry Module Template
Add the description of your module here.
> [!TIP]
> It is essential to provide a clear and comprehensive description of your module. A well-written description helps users understand the purpose and functionality of your module. For more information on how to write effective module descriptions, please refer to the [Terraform Registry documentation](https://registry.terraform.io/).
### Features
This module provides:
> [!TIP]
> When describing the features of your module, focus on clarity and brevity. Highlight the key functionalities and benefits without unnecessary jargon. This helps users quickly grasp what your module offers and how it can be beneficial for their projects.
- 🚀 Add feature here
- 🚀 Add feature here
- 🚀 Add feature here
### Usage
## Contributing
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct and the process for submitting pull requests.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
### Documentation References
- **Tests** (`/tests`):
- [Testing Overview and Guidelines](/tests/README.md)
- Comprehensive infrastructure testing using Terratest
- Includes unit, integration, and validation tests
- **Scripts** (`/scripts`):
- [Development Utilities and Workflow](/scripts/README.md)
- Helper scripts for Git hooks, repository maintenance
- Standardized development process automation
- **Modules** (`/modules`):
- [Module Development Guidelines](/modules/README.md)
- [Terraform Modules StyleGuide](/docs/terraform-styleguide/terraform-styleguide-modules.md)
- Reusable, well-structured Terraform module implementations
- **Examples** (`/examples`):
- [Module Usage Examples](/examples/README.md)
- Practical configurations demonstrating module usage
- Progressive complexity from basic to advanced scenarios
- **Docs** (`/docs`):
- [Developer Tools Guide](/docs/guides/development-tools-guide.md)
- Terraform StyleGuide:
- [Code Guidelines](/docs/terraform-styleguide/terraform-styleguide-code.md)
- [Modules Guidelines](/docs/terraform-styleguide/terraform-styleguide-modules.md)
- [Examples Guidelines](/docs/terraform-styleguide/terraform-styleguide-examples.md)
- [Terratest Guidelines](/docs/terraform-styleguide/terraform-styleguide-terratest.md)
- [Project Roadmap](/docs/ROADMAP.md)
- Comprehensive project documentation and future plans
**📘 Additional Resources:**
- [Contribution Guidelines](CONTRIBUTING.md)
- [Terraform Registry Module Best Practices](/docs/terraform-styleguide/terraform-styleguide-modules.md)