Skip to content

Latest commit

 

History

History
39 lines (27 loc) · 1.47 KB

CONTRIBUTING.md

File metadata and controls

39 lines (27 loc) · 1.47 KB
Raw

Contributing

Contributions are welcome.

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.

Pull Request Process

  1. Update the README.md with details of changes including example hcl blocks and example files if appropriate.
  2. Add appropriate tests.
  3. Run pre-commit hooks pre-commit run -a.
  4. Once all outstanding comments and checklist items have been addressed, your contribution will be merged!

Merged PRs will be included in the next release.

Checklists for contributions

  • 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.
  • Run pre-commit hooks pre-commit run -a

Semantic Pull Requests

To generate changelog, Pull Requests or Commits must have semantic and must follow conventional specs below:

  • feat: for new features
  • fix: for bug fixes
  • improvement: for enhancements
  • docs: for documentation and examples
  • refactor: for code refactoring
  • test: for tests
  • ci: for CI purpose
  • chore: for chores stuff

The chore prefix skipped during changelog generation. It can be used for chore: update changelog commit message by example.