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.
- Ensure any install or build dependencies are removed before the end of the layer when doing a build.
- Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations, and container parameters.
- Once all outstanding comments and checklist items have been addressed, your contribution will be merged! Merged PRs will be included in the next release.
- 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.
To generate changelog, Pull Requests or Commits must have semantic and must follow conventional specs below:
feat:
for new featuresfix:
for bug fixesimprovement:
for enhancementsdocs:
for documentation and examplesrefactor:
for code refactoringtest:
for testsci:
for CI purposechore:
for chores stuff
The chore
prefix skipped during changelog generation. It can be used for chore: update changelog
commit message by example.