| {"componentChunkName":"component---src-templates-main-jsx","path":"/contributing/","result":{"data":{"markdownRemark":{"html":"<div class=\"hero\">\n<div class=\"hero-content\">\n<h1 id=\"contributing-guide\" style=\"position:relative;\"><a href=\"#contributing-guide\" aria-label=\"contributing guide permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a>Contributing guide</h1>\n<p>Thanks for being interested in contributing to Eclipse JKube!</p>\n</div>\n</div>\n<h3 id=\"want-to-contribute\" style=\"position:relative;\"><a href=\"#want-to-contribute\" aria-label=\"want to contribute permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a>Want to contribute?</h3>\n<p><strong>Great!</strong> We try to make it easy, and all contributions, even the smaller ones, are more than welcome.</p>\n<p>This includes bug reports, fixes, documentation, examples... But first, please read this page.</p>\n<h2 id=\"legal\" style=\"position:relative;\"><a href=\"#legal\" aria-label=\"legal permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a>Legal</h2>\n<p>All original contributions to Eclipse JKube are licensed under the\n<a href=\"https://github.com/eclipse/jkube/blob/master/LICENSE\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">Eclipse Public License - v2.0</a>.</p>\n<p>First step before submitting any pull request is singing an\n<a href=\"https://accounts.eclipse.org/user/eca\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">Eclipse Contributor Agreement</a>.</p>\n<p>To complete this step you'll need an <a href=\"https://accounts.eclipse.org/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">Eclipse account</a>.</p>\n<h2 id=\"reporting-an-issue\" style=\"position:relative;\"><a href=\"#reporting-an-issue\" aria-label=\"reporting an issue permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a>Reporting an issue</h2>\n<p>Eclipse JKube uses <a href=\"https://github.com/eclipse/jkube/issues\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">GitHub</a> to manage the issues.\n<a href=\"https://github.com/eclipse/jkube/issues/new\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">Open</a> an issue directly in GitHub.</p>\n<p>If you believe you found a bug (It's very likely you did), please open an issue\nindicating a way to reproduce it, what you are seeing and what you are expecting to see.</p>\n<p>If you want your issue to be resolved quickly, please include in your issue:</p>\n<ul>\n<li>Operating System</li>\n<li>Eclipse JKube version</li>\n<li>Java version</li>\n<li>Maven version</li>\n<li>Target cluster version (Kubernetes, OpenShift, Minikube, CRC, etc.)</li>\n</ul>\n<h2 id=\"before-you-contribute\" style=\"position:relative;\"><a href=\"#before-you-contribute\" aria-label=\"before you contribute permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a>Before you contribute</h2>\n<p>To contribute use GitHub <a href=\"https://github.com/eclipse/jkube/pulls\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">pull requests</a> from your <strong>own</strong> fork.</p>\n<p>All commits must be <a href=\"https://git-scm.com/docs/git-commit#Documentation/git-commit.txt---signoff\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">signed-off</a>\nby a user that has signed the\n<a href=\"https://www.eclipse.org/legal/ECA.php\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">Eclipse Contributor Agreement</a>.</p>\n<h3 id=\"code-reviews\" style=\"position:relative;\"><a href=\"#code-reviews\" aria-label=\"code reviews permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a>Code reviews</h3>\n<p>All reviews, including submissions by project members, need to be reviewed before being merged by the project official\n<a href=\"https://projects.eclipse.org/projects/ecd.jkube/who\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">committers</a>.</p>\n<h3 id=\"tests-and-documentation\" style=\"position:relative;\"><a href=\"#tests-and-documentation\" aria-label=\"tests and documentation permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a>Tests and documentation</h3>\n<p>Don't forget to include unit tests in your pull requests along with documentation (Reference information, javadoc, etc.).</p>\n<h2 id=\"setup\" style=\"position:relative;\"><a href=\"#setup\" aria-label=\"setup permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a>Setup</h2>\n<h3 id=\"ide-config-and-code-style\" style=\"position:relative;\"><a href=\"#ide-config-and-code-style\" aria-label=\"ide config and code style permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a>IDE Config and Code Style</h3>\n<p>Code formatting is done by the Eclipse code formatter using the configuration files found in the <code class=\"language-text\">ide-config</code> directory.</p>\n<h4 id=\"eclipse-setup\" style=\"position:relative;\"><a href=\"#eclipse-setup\" aria-label=\"eclipse setup permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a>Eclipse Setup</h4>\n<p>Open the Preferences window, and then navigate to Java -> Code Style -> Formatter.\nClick Import and then select the <code class=\"language-text\">eclipse-format.xml</code> file in the <code class=\"language-text\">ide-config</code> directory.</p>\n<p>Next navigate to Java -> Code Style -> Organize Imports.\nClick Import and select the <code class=\"language-text\">eclipse.importorder</code> file in the <code class=\"language-text\">ide-config</code> directory.</p>\n<h4 id=\"idea-setup\" style=\"position:relative;\"><a href=\"#idea-setup\" aria-label=\"idea setup permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a>IDEA Setup</h4>\n<p>Open the Preferences window (or Settings depending on your edition), navigate to Plugins and install the\n<a href=\"https://plugins.jetbrains.com/plugin/6546-eclipse-code-formatter\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">Eclipse Code Formatter Plugin</a> from the Marketplace.</p>\n<p>Restart your IDE, open the Preferences (or Settings) window again and navigate to Other Settings -> Eclipse Code Formatter.</p>\n<p>Select Use the Eclipse Code Formatter, then change the Eclipse Java Formatter Config File to point to the\n<code class=\"language-text\">eclipse-format.xml</code> file in the <code class=\"language-text\">ide-config</code> directory.</p>\n<p>Make sure the Optimize Imports box is ticked, and select the <code class=\"language-text\">eclipse.importorder</code> file as the import order config file.</p>\n<p><img src=\"/jkube/40db5a95d875815a4fddb66504f92f51/intellij-eclipse-code-formatter-settings.png\" alt=\"IntelliJ Eclipse Code Formatter Settings\" title=\"Eclipse Code Formatter Plugin\"></p>","frontmatter":{"date":"February 28, 2020","path":"/contributing","title":"Contributing to Eclipse JKube","description":"Eclipse JKube contributing main guidelines"}}},"pageContext":{"langKey":"en","slug":"/contributing/"}},"staticQueryHashes":[]} |