We'd love to accept your patches and contributions to this project!!
To get started developing, see our DEVELOPMENT.md.
In this file you'll find info on:
All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult GitHub Help for more information on using pull requests.
This section describes the standards we will try to maintain in this repo.
Reference the related issue in the subject using a short prefix to indicate which repository the issue lives in:
| Prefix | Repository |
|---|---|
mzNNN |
This repository (osscontainertools/kaniko, formerly mzihlmann/kaniko) |
cgNNN |
Chainguard fork (chainguard-dev/kaniko) |
NNN (no prefix) |
Original Google repository (GoogleContainerTools/kaniko) |
For bug fixes, add a body paragraph describing the incorrect behavior and why the fix resolves it.
For simple changes with no associated issue, a subject line alone is fine.
New behavior that would change kaniko's output or semantics must ship behind a feature flag rather than directly. This keeps patch releases stable. See docs/releases.md for the full policy and a guide on when a feature flag is needed.
The code in this repo should follow best practices, specifically:
Thanks so much for considering contributing to our project!! We hope very much you can find something interesting to work on:
- To find issues that we particularly would like contributors to tackle, look for issues with the "help wanted" label.
- Issues that are good for new folks will additionally be marked with "good first issue".