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.
- Update the README.md with details of changes including new example Dockerfile if appropriate.
- 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 module maintainers take care of updating the CHANGELOG as they merge.
- 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 generate changelog, Pull Requests or Commits must have semantic and must follow conventional specs below:
feat:
for new featuresfix:
for bug fixesperf:
for performance improvementsdocs:
for documentation and examplesstyle
: for formatting changesrefactor:
for refactoring production codetest:
for adding missing testsci:
for CI purposechore:
for chores stuffbuild:
for updating build configuration
chore docs ci build refactor style
prefixes are skipped during changelog generation.
They can be used for chore: update changelog
commit message by example.