github.com/GoogleContainerTools/kaniko@v1.23.0/CONTRIBUTING.md (about) 1 # Contributing to Kaniko 2 3 We'd love to accept your patches and contributions to this project!! 4 5 To get started developing, see our [DEVELOPMENT.md](./DEVELOPMENT.md). 6 7 In this file you'll find info on: 8 9 - [Contributing to Kaniko](#contributing-to-kaniko) 10 - [Contributor License Agreement](#contributor-license-agreement) 11 - [Code reviews](#code-reviews) 12 - [Standards](#standards) 13 - [Commit Messages](#commit-messages) 14 - [Coding standards](#coding-standards) 15 - [Finding something to work on](#finding-something-to-work-on) 16 [code](#coding-standards) 17 - [Finding something to work on](#finding-something-to-work-on) 18 19 ## Contributor License Agreement 20 21 Contributions to this project must be accompanied by a Contributor License 22 Agreement. You (or your employer) retain the copyright to your contribution; 23 this simply gives us permission to use and redistribute your contributions as 24 part of the project. Head over to <https://cla.developers.google.com/> to see 25 your current agreements on file or to sign a new one. 26 27 You generally only need to submit a CLA once, so if you've already submitted one 28 (even if it was for a different project), you probably don't need to do it 29 again. 30 31 ## Code reviews 32 33 All submissions, including submissions by project members, require review. We 34 use GitHub pull requests for this purpose. Consult 35 [GitHub Help](https://help.github.com/articles/about-pull-requests/) for more 36 information on using pull requests. 37 38 ## Standards 39 40 This section describes the standards we will try to maintain in this repo. 41 42 ### Commit Messages 43 44 All commit messages should follow 45 [these best practices](https://chris.beams.io/posts/git-commit/), specifically: 46 47 - Start with a subject line 48 - Contain a body that explains _why_ you're making the change you're making 49 - Reference an issue number if one exists, closing it if applicable (with text 50 such as 51 ["Fixes #245" or "Closes #111"](https://help.github.com/articles/closing-issues-using-keywords/)) 52 53 Aim for [2 paragraphs in the body](https://www.youtube.com/watch?v=PJjmw9TRB7s). 54 Not sure what to put? Include: 55 56 - What is the problem being solved? 57 - Why is this the best approach? 58 - What other approaches did you consider? 59 - What side effects will this approach have? 60 - What future work remains to be done? 61 62 ### Coding standards 63 64 The code in this repo should follow best practices, specifically: 65 66 - [Go code review comments](https://go.dev/wiki/CodeReviewComments) 67 68 ## Finding something to work on 69 70 Thanks so much for considering contributing to our project!! We hope very much 71 you can find something interesting to work on: 72 73 - To find issues that we particularly would like contributors to tackle, look 74 for 75 [issues with the "help wanted" label](https://github.com/GoogleContainerTools/kaniko/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22). 76 - Issues that are good for new folks will additionally be marked with 77 ["good first issue"](https://github.com/GoogleContainerTools/kaniko/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).