From c7476b7aebe6d9cf7d698b4d8ec288f156ba7d9b Mon Sep 17 00:00:00 2001 From: drewmullen Date: Tue, 7 Jun 2022 11:14:01 -0400 Subject: [PATCH] contributing guide --- .header.md | 4 ++++ README.md | 4 ++++ developer.md => contributing.md | 2 +- 3 files changed, 9 insertions(+), 1 deletion(-) rename developer.md => contributing.md (97%) diff --git a/.header.md b/.header.md index 3c98b84..b2edeb6 100644 --- a/.header.md +++ b/.header.md @@ -134,3 +134,7 @@ Terraform Plan: # aws_route53recoveryreadiness_cell.cell_per_az["us-east-1b"] will be created ... ``` + +## Contributing + +Please see our [developer documentation](https://github.com/aws-ia/terraform-aws-vpc/contributing.md) for guidance on contributing to this module diff --git a/README.md b/README.md index e76d03f..459d9a8 100644 --- a/README.md +++ b/README.md @@ -136,6 +136,10 @@ Terraform Plan: ... ``` +## Contributing + +Please see our [developer documentation](https://github.com/aws-ia/terraform-aws-vpc/contributing.md) for guidance on contributing to this module + ## Requirements | Name | Version | diff --git a/developer.md b/contributing.md similarity index 97% rename from developer.md rename to contributing.md index b6830f8..9369745 100644 --- a/developer.md +++ b/contributing.md @@ -2,7 +2,7 @@ ## Outputs Methodology -This module organizes outputs by creating output collections of grouped entire resources. The benefit of this is that, most likely, attributes users want access to are already present without having to create new `output {}` for each possible attribute. The [potential] downside is that you will have to extract it yourself using HCL logic. See the [outputs.tf](https://github.com/aws-ia/terraform-aws-vpc/blob/b7396f072a95feb367fbc0916f1d2b83a24649df/outputs.tf) for examples. +This module organizes outputs by creating output collections of grouped entire resources. The benefit of this is that, most likely, attributes users want access to are already present without having to create new `output {}` for each possible attribute. The [potential] downside is that you will have to extract it yourself using HCL logic. See the [outputs.tf](https://github.com/aws-ia/terraform-aws-vpc/outputs.tf) for examples. Our naming convetion attempts to make the output content clear. `route_table_attributes_by_type_by_az` is a nested map of route table resource attributes grouped by their subnet type then by the az. Example: ```terraform