Skip to content

Commit

Permalink
contributing guide
Browse files Browse the repository at this point in the history
  • Loading branch information
drewmullen committed Jun 7, 2022
1 parent 31e21c3 commit c7476b7
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 1 deletion.
4 changes: 4 additions & 0 deletions .header.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down
2 changes: 1 addition & 1 deletion developer.md → contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit c7476b7

Please sign in to comment.