You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
0 commit comments