Skip to content

Commit

Permalink
include contributing guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
drewmullen committed Oct 14, 2021
1 parent d0feab5 commit 4fc916a
Show file tree
Hide file tree
Showing 4 changed files with 43 additions and 2 deletions.
34 changes: 34 additions & 0 deletions .github/contributing.md
Original file line number Diff line number Diff line change
@@ -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.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
## Requirements

Expand Down
2 changes: 1 addition & 1 deletion examples/vpc-flow-logs/main.tf
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
3 changes: 2 additions & 1 deletion vpc-flow-logs.tf
Original file line number Diff line number Diff line change
Expand Up @@ -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
}
Expand Down

0 comments on commit 4fc916a

Please sign in to comment.