mirror of
https://github.com/ysoftdevs/terraform-aws-eks.git
synced 2026-03-20 08:33:46 +01:00
docs: Fix typos in README and CONTRIBUTING (#1167)
This commit is contained in:
8
.github/CONTRIBUTING.md
vendored
8
.github/CONTRIBUTING.md
vendored
@@ -8,18 +8,18 @@ Please note we have a code of conduct, please follow it in all your interactions
|
||||
## Pull Request Process
|
||||
|
||||
1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
|
||||
2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
|
||||
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-eks mainteners takes care of updating the CHANGELOG as they merge.
|
||||
2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations, and container parameters.
|
||||
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-eks maintainers take care of updating the CHANGELOG as they merge.
|
||||
|
||||
## Checklists for contributions
|
||||
|
||||
- [ ] Add [sementics prefix](#semantic-pull-requests) to your PR or Commits (at leats one of your commit groups)
|
||||
- [ ] Add [semantics prefix](#semantic-pull-requests) 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-eks/#doc-generation
|
||||
|
||||
## Semantic Pull Requests
|
||||
|
||||
To generate changelog, Pull Requests or Commits must have sementic and must follow conventional specs below:
|
||||
To generate changelog, Pull Requests or Commits must have semantic and must follow conventional specs below:
|
||||
|
||||
- `feat:` for new features
|
||||
- `fix:` for bug fixes
|
||||
|
||||
Reference in New Issue
Block a user