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.
- Update the README.md with details of changes including example hcl blocks and example files if appropriate.
- Run pre-commit hooks
pre-commit run -a. - 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.
- Add semantics prefix 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
To generate changelog, Pull Requests or Commits must have semantic and must follow conventional specs below:
feat:for new featuresfix:for bug fixesimprovement:for enhancementsdocs:for documentation and examplesrefactor:for code refactoringtest:for testsci:for CI purposechore:for chores stuff
The chore prefix skipped during changelog generation. It can be used for chore: update changelog commit message by example.