Skip to content

Commit 0c173ec

Browse files
committed
include contributing guidelines
1 parent d0feab5 commit 0c173ec

File tree

2 files changed

+41
-0
lines changed

2 files changed

+41
-0
lines changed

.github/contributing.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
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. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
11+
2. Update the README.md with details of changes including example hcl blocks and [example files](./examples) if appropriate.
12+
3. Run pre-commit hooks `pre-commit run -a`.
13+
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.
14+
15+
## Checklists for contributions
16+
17+
- [ ] Add [semantics prefix](#semantic-pull-requests) to your PR or Commits (at least one of your commit groups)
18+
- [ ] CI tests are passing
19+
- [ ] README.md has been updated after any changes to variables and outputs. See https://github.com/terraform-aws-modules/terraform-aws-vpc/#doc-generation
20+
- [ ] Run pre-commit hooks `pre-commit run -a`
21+
22+
## Semantic Pull Requests
23+
24+
To generate changelog, Pull Requests or Commits must have semantic and must follow conventional specs below:
25+
26+
- `feat:` for new features
27+
- `fix:` for bug fixes
28+
- `improvement:` for enhancements
29+
- `docs:` for documentation and examples
30+
- `refactor:` for code refactoring
31+
- `test:` for tests
32+
- `ci:` for CI purpose
33+
- `chore:` for chores stuff
34+
35+
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

0 commit comments

Comments
 (0)