First and foremost, thank you for considering contributing to this project!
Before making any contributions, please take a moment to read through this CONTRIBUTING document and the project's README, to understand how the project works.
This guideline applies to both Image Maintainers and OCI Factory Developers:
- Image Maintainer: also referred to as "Maintainer", is the Canonical entity that owns and is responsible for an Ubuntu OCI image that is being processed within this repository;
- OCI Factory Developer: anyone who contributes to the source code hosted in this repository, which is being used to process the workflows and images proposed by the Maintainers.
This project and everyone participating in it must follow a Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behaviour to [email protected].
Before you contribute you should sign the Canonical contributor agreement. It's the easiest way for you to permit us to use your contributions.
Once comfortable with and abiding by the aforementioned concepts and practices, please make sure you follow these guidelines when committing content for this repository:
-
format your commit messages according to the Conventional Commits specification. Example:
build(my-rock-name): build new version 1.3 of my-rock-name This is some additional and optional context explaining why this change is being made and what impact it will have.
-
if a PR has multiple commits, group (squash) them according to their functional value, e.g. you shouldn't have multiple commits for fixing a single bug within the same code block,
-
if a PR is still being worked on, make sure to set it to "Draft",
-
unless it's a trivial fix/improvement, it's generally worth opening an issue (making sure a similar one doesn't exist already) to discuss the item before submitting a PR,
-
if you are a Maintainer, you MUST acknowledge the conditions established in the Image Maintainer Agreement.