We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
Contributions to this project are welcome under the Apache license.
Please note that this project is released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.
- Found a bug? Report it here
- Have a feature idea? Submit it here
- Fork and clone the repository.
- Create a new branch:
git checkout -b my-branch-name. - Make your changes, ensuring that they include steps to install and validation post-install
- Test your changes by creating and deploying the image
- Push to your fork and [submit a pull request][pr].
All commit messages must include a Sign-off line
Please consider out commit message standards in order for your contribution to be merged into the main branch.
- Conciseness: Limit the subject line to around 50 characters to ensure readability in various Git tools.
- Imperative Mood: Use the imperative mood, as if giving a command. For example, "Fix bug" instead of "Fixed bug" or "Fixes bug."
- Capitalization: Capitalize the first letter of the subject line.
- No Period: Do not end the subject line with a period.
- Clarity: Summarize the core change or purpose of the commit clearly and directly.
- Separate from Subject: Leave a blank line between the subject line and the body.
- Explain "What" and "Why": Detail what changes were made and, more importantly, why those changes were necessary. Focus on the problem solved or the feature implemented, rather than the specific implementation details (the "how").
- Wrap Lines: Wrap body lines at approximately 72 characters for better readability.
- Provide Context: Include any relevant context, such as links to issues, bug reports, or design documents, if applicable.
- Explain Side Effects: Note any potential side effects or non-obvious consequences of the changes.