Skip to content

Commit 31bdd78

Browse files
committed
include contributing guidelines
1 parent d0feab5 commit 31bdd78

File tree

4 files changed

+43
-2
lines changed

4 files changed

+43
-2
lines changed

.github/contributing.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Contributing
2+
3+
When contributing to this repository, please first discuss the change you wish to make via issue,
4+
email, or any other method with the owners of this repository before making a change.
5+
6+
Please note we have a code of conduct, please follow it in all your interactions with the project.
7+
8+
## Pull Request Process
9+
10+
1. Update the README.md with details of changes including example hcl blocks and [example files](./examples) if appropriate.
11+
2. Run pre-commit hooks `pre-commit run -a`.
12+
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.
13+
14+
## Checklists for contributions
15+
16+
- [ ] Add [semantics prefix](#semantic-pull-requests) to your PR or Commits (at least one of your commit groups)
17+
- [ ] CI tests are passing
18+
- [ ] README.md has been updated after any changes to variables and outputs. See https://github.com/terraform-aws-modules/terraform-aws-vpc/#doc-generation
19+
- [ ] Run pre-commit hooks `pre-commit run -a`
20+
21+
## Semantic Pull Requests
22+
23+
To generate changelog, Pull Requests or Commits must have semantic and must follow conventional specs below:
24+
25+
- `feat:` for new features
26+
- `fix:` for bug fixes
27+
- `improvement:` for enhancements
28+
- `docs:` for documentation and examples
29+
- `refactor:` for code refactoring
30+
- `test:` for tests
31+
- `ci:` for CI purpose
32+
- `chore:` for chores stuff
33+
34+
The `chore` prefix skipped during changelog generation. It can be used for `chore: update changelog` commit message by example.

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -191,6 +191,12 @@ It is possible to integrate this VPC module with [terraform-aws-transit-gateway
191191
- [Manage Default VPC](https://github.com/terraform-aws-modules/terraform-aws-vpc/tree/master/examples/manage-default-vpc)
192192
- [Few tests and edge case examples](https://github.com/terraform-aws-modules/terraform-aws-vpc/tree/master/examples/issues)
193193

194+
## Contributing
195+
196+
Report issues/questions/feature requests on in the [issues](https://github.com/terraform-aws-modules/terraform-aws-vpc/issues/new) section.
197+
198+
Full contributing [guidelines are covered here](.github/CONTRIBUTING.md).
199+
194200
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
195201
## Requirements
196202

examples/vpc-flow-logs/main.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ module "vpc_with_flow_logs_s3_bucket_parquet" {
4343
enable_flow_log = true
4444
flow_log_destination_type = "s3"
4545
flow_log_destination_arn = module.s3_bucket.this_s3_bucket_arn
46-
flow_log_file_format = "parquet"
46+
flow_log_file_format = "parquet"
4747

4848
vpc_flow_log_tags = {
4949
Name = "vpc-flow-logs-s3-bucket"

vpc-flow-logs.tf

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,9 @@ resource "aws_flow_log" "this" {
2323
traffic_type = var.flow_log_traffic_type
2424
vpc_id = local.vpc_id
2525
max_aggregation_interval = var.flow_log_max_aggregation_interval
26+
2627
destination_options {
27-
file_format = var.flow_log_file_format
28+
file_format = var.flow_log_file_format
2829
flow_log_hive_compatible_partitions = var.flow_log_hive_compatible_partitions
2930
flow_log_per_hour_partition = var.flow_log_per_hour_partition
3031
}

0 commit comments

Comments
 (0)