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.
- Update the README.md of the module with details of changes to the interface. Ideally use the pre-commit hook to automatically update the variables/outputs of each module.
- 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 maintainers take care of updating the CHANGELOG as they tag new releases.
- Add a changelog prefix to your PR or Commits (at leats one of your commit groups)
- Validation actions are passing
- README.md has been updated after any changes to variables and outputs. See https://github.com/commitdev/terraform-aws-https-redirect/#doc-generation
To be able to generate a changelog, Pull Requests or Commit messages must have one of the following prefixes:
feat:
for new featuresfix:
for bug fixesimprovement:
for enhancementsdocs:
for documentation and examplesrefactor:
for code refactoringci:
for CI purposechore:
for chores
The chore
prefix is skipped during changelog generation. It can be used for a chore: update changelog
commit message by example.