From 4fc916a15ebf2f1bdfed4187930e285ed74775d2 Mon Sep 17 00:00:00 2001 From: drewmullen Date: Thu, 14 Oct 2021 08:23:11 -0400 Subject: [PATCH] include contributing guidelines --- .github/contributing.md | 34 ++++++++++++++++++++++++++++++++++ README.md | 6 ++++++ examples/vpc-flow-logs/main.tf | 2 +- vpc-flow-logs.tf | 3 ++- 4 files changed, 43 insertions(+), 2 deletions(-) create mode 100644 .github/contributing.md diff --git a/.github/contributing.md b/.github/contributing.md new file mode 100644 index 000000000..b7c27a5cc --- /dev/null +++ b/.github/contributing.md @@ -0,0 +1,34 @@ +# Contributing + +When contributing to this repository, please first discuss the change you wish to make via issue, +email, or any other method with the owners of this repository before making a change. + +Please note we have a code of conduct, please follow it in all your interactions with the project. + +## Pull Request Process + +1. Update the README.md with details of changes including example hcl blocks and [example files](./examples) if appropriate. +2. Run pre-commit hooks `pre-commit run -a`. +3. Once all outstanding comments and checklist items have been addressed, your contribution will be merged! Merged PRs will be included in the next release. The terraform-aws-vpc maintainers take care of updating the CHANGELOG as they merge. + +## Checklists for contributions + +- [ ] Add [semantics prefix](#semantic-pull-requests) to your PR or Commits (at least one of your commit groups) +- [ ] CI tests are passing +- [ ] README.md has been updated after any changes to variables and outputs. See https://github.com/terraform-aws-modules/terraform-aws-vpc/#doc-generation +- [ ] Run pre-commit hooks `pre-commit run -a` + +## Semantic Pull Requests + +To generate changelog, Pull Requests or Commits must have semantic and must follow conventional specs below: + +- `feat:` for new features +- `fix:` for bug fixes +- `improvement:` for enhancements +- `docs:` for documentation and examples +- `refactor:` for code refactoring +- `test:` for tests +- `ci:` for CI purpose +- `chore:` for chores stuff + +The `chore` prefix skipped during changelog generation. It can be used for `chore: update changelog` commit message by example. diff --git a/README.md b/README.md index 6c8a4b1ca..5f7d2d562 100644 --- a/README.md +++ b/README.md @@ -191,6 +191,12 @@ It is possible to integrate this VPC module with [terraform-aws-transit-gateway - [Manage Default VPC](https://github.com/terraform-aws-modules/terraform-aws-vpc/tree/master/examples/manage-default-vpc) - [Few tests and edge case examples](https://github.com/terraform-aws-modules/terraform-aws-vpc/tree/master/examples/issues) +## Contributing + +Report issues/questions/feature requests on in the [issues](https://github.com/terraform-aws-modules/terraform-aws-vpc/issues/new) section. + +Full contributing [guidelines are covered here](.github/contributing.md). + ## Requirements diff --git a/examples/vpc-flow-logs/main.tf b/examples/vpc-flow-logs/main.tf index 321ba0064..61562358f 100644 --- a/examples/vpc-flow-logs/main.tf +++ b/examples/vpc-flow-logs/main.tf @@ -43,7 +43,7 @@ module "vpc_with_flow_logs_s3_bucket_parquet" { enable_flow_log = true flow_log_destination_type = "s3" flow_log_destination_arn = module.s3_bucket.this_s3_bucket_arn - flow_log_file_format = "parquet" + flow_log_file_format = "parquet" vpc_flow_log_tags = { Name = "vpc-flow-logs-s3-bucket" diff --git a/vpc-flow-logs.tf b/vpc-flow-logs.tf index f3e54e1ac..941d711b6 100644 --- a/vpc-flow-logs.tf +++ b/vpc-flow-logs.tf @@ -23,8 +23,9 @@ resource "aws_flow_log" "this" { traffic_type = var.flow_log_traffic_type vpc_id = local.vpc_id max_aggregation_interval = var.flow_log_max_aggregation_interval + destination_options { - file_format = var.flow_log_file_format + file_format = var.flow_log_file_format flow_log_hive_compatible_partitions = var.flow_log_hive_compatible_partitions flow_log_per_hour_partition = var.flow_log_per_hour_partition }