CONTRIBUTING.md

Contributing

When contributing to this repository, please first create an issue and link the PR with it.

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 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 to your PR or Commits.
• CI tests are passing
• README.md has been updated after any changes. The variables and outputs in the README.md has been generated (using the terraform_docs pre-commit hook).
• Run pre-commit hooks pre-commit run -a

Semantic Pull Requests

Pull Requests or Commits must follow conventional specs below:

• ci: Changes to our CI configuration files and scripts (example scopes: GitHub Actions)
• docs: Documentation only changes
• feat: A new feature
• fix: A bug fix
• refactor: A code change that neither fixes a bug nor adds a feature
• style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
• test: Adding missing tests or correcting existing tests