-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathcomponent---src-templates-main-jsx-content-file-path-src-content-contributing-index-mdx-3dbdaff67ae0d947bd8e.js
2 lines (2 loc) · 47 KB
/
component---src-templates-main-jsx-content-file-path-src-content-contributing-index-mdx-3dbdaff67ae0d947bd8e.js
1
2
"use strict";(self.webpackChunkjkube_website=self.webpackChunkjkube_website||[]).push([[24],{8523:function(e,t,n){n.r(t),n.d(t,{Head:function(){return u},default:function(){return h}});var l=n(1151),r=n(7294),a=n(2721);function o(e){const t=Object.assign({h1:"h1",a:"a",span:"span",p:"p",h2:"h2",strong:"strong",ul:"ul",li:"li",h3:"h3",ol:"ol",pre:"pre",code:"code",h4:"h4",h5:"h5",img:"img"},(0,l.ah)(),e.components);return r.createElement(r.Fragment,null,r.createElement(a.VM,null,r.createElement(t.h1,{id:"contributing-guide",style:{position:"relative"}},r.createElement(t.a,{href:"#contributing-guide","aria-label":"contributing guide permalink",className:"anchor before"},r.createElement(t.span,{dangerouslySetInnerHTML:{__html:'<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>'}})),"Contributing guide"),r.createElement(t.p,null,"Thanks for being interested in contributing to Eclipse JKube!")),"\n",r.createElement(t.h2,{id:"want-to-contribute",style:{position:"relative"}},r.createElement(t.a,{href:"#want-to-contribute","aria-label":"want to contribute permalink",className:"anchor before"},r.createElement(t.span,{dangerouslySetInnerHTML:{__html:'<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>'}})),"Want to contribute?"),"\n",r.createElement(t.p,null,r.createElement(t.strong,null,"Great!")," We try to make it easy, and all contributions, even the smaller ones, are more than welcome."),"\n",r.createElement(t.p,null,"This includes bug reports, fixes, documentation, examples... But first, please read this page."),"\n",r.createElement(t.h2,{id:"table-of-contents",style:{position:"relative"}},r.createElement(t.a,{href:"#table-of-contents","aria-label":"table of contents permalink",className:"anchor before"},r.createElement(t.span,{dangerouslySetInnerHTML:{__html:'<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>'}})),"Table of Contents"),"\n",r.createElement(t.ul,null,"\n",r.createElement(t.li,null,r.createElement(t.a,{href:"#legal"},"Legal")),"\n",r.createElement(t.li,null,r.createElement(t.a,{href:"#reporting-an-issue"},"Reporting an issue")),"\n",r.createElement(t.li,null,r.createElement(t.a,{href:"#get-the-code"},"Get the Code")),"\n",r.createElement(t.li,null,r.createElement(t.a,{href:"#before-you-contribute"},"Before you contribute"),"\n",r.createElement(t.ul,null,"\n",r.createElement(t.li,null,r.createElement(t.a,{href:"#trying-out-project-as-end-user"},"Trying out project as end user")),"\n",r.createElement(t.li,null,r.createElement(t.a,{href:"#finding-an-issue-to-work-on"},"Finding an issue to work on"),"\n",r.createElement(t.ul,null,"\n",r.createElement(t.li,null,r.createElement(t.a,{href:"#first-timers-only-issues"},"First Timers Only Issues")),"\n",r.createElement(t.li,null,r.createElement(t.a,{href:"#good-first-issues"},"Good First Issues")),"\n",r.createElement(t.li,null,r.createElement(t.a,{href:"#help-wanted-issues"},"Help Wanted Issues")),"\n"),"\n"),"\n"),"\n"),"\n",r.createElement(t.li,null,r.createElement(t.a,{href:"#development-tools"},"Development Tools")),"\n",r.createElement(t.li,null,r.createElement(t.a,{href:"#project-setup"},"Project Setup"),"\n",r.createElement(t.ul,null,"\n",r.createElement(t.li,null,r.createElement(t.a,{href:"#building-project-locally"},"Building Project Locally")),"\n",r.createElement(t.li,null,r.createElement(t.a,{href:"#testing-local-build"},"Testing Local Build")),"\n",r.createElement(t.li,null,r.createElement(t.a,{href:"#debugging-plugins"},"Debugging Plugins")),"\n",r.createElement(t.li,null,r.createElement(t.a,{href:"#ide-config-and-code-style"},"IDE Config and Code Style")),"\n",r.createElement(t.li,null,r.createElement(t.a,{href:"#gitpod"},"GitPod")),"\n",r.createElement(t.li,null,r.createElement(t.a,{href:"#eclipse-ide-setup"},"Eclipse IDE Setup")),"\n",r.createElement(t.li,null,r.createElement(t.a,{href:"#intellij-idea-setup"},"IntelliJ IDEA Setup")),"\n"),"\n"),"\n",r.createElement(t.li,null,r.createElement(t.a,{href:"#working-on-issue"},"Working on Issue"),"\n",r.createElement(t.ul,null,"\n",r.createElement(t.li,null,r.createElement(t.a,{href:"#commit-signoff"},"Commit SignOff")),"\n",r.createElement(t.li,null,r.createElement(t.a,{href:"#code-reviews"},"Code reviews")),"\n",r.createElement(t.li,null,r.createElement(t.a,{href:"#test-and-documentation-are-not-optional"},"Tests and documentation are not optional")),"\n"),"\n"),"\n",r.createElement(t.li,null,r.createElement(t.a,{href:"#workflow-tips"},"Workflow Tips")),"\n",r.createElement(t.li,null,r.createElement(t.a,{href:"#documentation"},"Documentation"),"\n",r.createElement(t.ul,null,"\n",r.createElement(t.li,null,r.createElement(t.a,{href:"#building-documentation"},"Building Documentation")),"\n"),"\n"),"\n",r.createElement(t.li,null,r.createElement(t.a,{href:"#frequently-asked-questions"},"Frequently Asked Questions")),"\n"),"\n",r.createElement(t.h3,{id:"legal",style:{position:"relative"}},r.createElement(t.a,{href:"#legal","aria-label":"legal permalink",className:"anchor before"},r.createElement(t.span,{dangerouslySetInnerHTML:{__html:'<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>'}})),"Legal"),"\n",r.createElement(t.p,null,"All original contributions to Eclipse JKube are licensed under the\n",r.createElement(t.a,{href:"https://github.com/eclipse-jkube/jkube/blob/master/LICENSE",target:"_blank",rel:"nofollow noopener noreferrer"},"Eclipse Public License - v2.0"),". You would need to complete\nsome legal steps before starting to contribute to the project."),"\n",r.createElement(t.ol,null,"\n",r.createElement(t.li,null,"Create an ",r.createElement(t.a,{href:"https://accounts.eclipse.org/",target:"_blank",rel:"nofollow noopener noreferrer"},"Eclipse account")),"\n",r.createElement(t.li,null,"Sign ",r.createElement(t.a,{href:"https://accounts.eclipse.org/user/eca",target:"_blank",rel:"nofollow noopener noreferrer"},"Eclipse Contributor Agreement")),"\n"),"\n",r.createElement(t.p,null,"Configure your local git config to set correct email address and name. This is important step as ECA validation check\ntries to infer contributor details via git commit:"),"\n",r.createElement(t.pre,null,r.createElement(t.code,{className:"language-shell"},'git config user.name "Your Name"\ngit config user.email "your_email@example.com"\n')),"\n",r.createElement(t.h3,{id:"reporting-an-issue",style:{position:"relative"}},r.createElement(t.a,{href:"#reporting-an-issue","aria-label":"reporting an issue permalink",className:"anchor before"},r.createElement(t.span,{dangerouslySetInnerHTML:{__html:'<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>'}})),"Reporting an issue"),"\n",r.createElement(t.p,null,"Eclipse JKube uses ",r.createElement(t.a,{href:"https://github.com/eclipse-jkube/jkube/issues",target:"_blank",rel:"nofollow noopener noreferrer"},"GitHub")," to manage the issues.\nPlease ",r.createElement(t.a,{href:"https://github.com/eclipse-jkube/jkube/issues/new",target:"_blank",rel:"nofollow noopener noreferrer"},"open")," an issue directly in GitHub."),"\n",r.createElement(t.p,null,"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."),"\n",r.createElement(t.p,null,"If you want your issue to be resolved quickly, please include in your issue:"),"\n",r.createElement(t.ul,null,"\n",r.createElement(t.li,null,"Operating System"),"\n",r.createElement(t.li,null,"Eclipse JKube version"),"\n",r.createElement(t.li,null,"Java version"),"\n",r.createElement(t.li,null,"Maven/Gradle version"),"\n",r.createElement(t.li,null,"Target cluster version (Kubernetes, OpenShift, Minikube, CRC, etc.)"),"\n"),"\n",r.createElement(t.h3,{id:"get-the-code",style:{position:"relative"}},r.createElement(t.a,{href:"#get-the-code","aria-label":"get the code permalink",className:"anchor before"},r.createElement(t.span,{dangerouslySetInnerHTML:{__html:'<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>'}})),"Get The Code"),"\n",r.createElement(t.p,null,"Project's source code is available on ",r.createElement(t.a,{href:"https://github.com/eclipse-jkube/jkube",target:"_blank",rel:"nofollow noopener noreferrer"},"GitHub"),". If you're interested in\ncontributing to the project, you need to ",r.createElement(t.a,{href:"https://github.com/eclipse-jkube/jkube/fork",target:"_blank",rel:"nofollow noopener noreferrer"},"fork the project"),"."),"\n",r.createElement(t.h3,{id:"before-you-contribute",style:{position:"relative"}},r.createElement(t.a,{href:"#before-you-contribute","aria-label":"before you contribute permalink",className:"anchor before"},r.createElement(t.span,{dangerouslySetInnerHTML:{__html:'<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>'}})),"Before you contribute"),"\n",r.createElement(t.p,null,"To contribute use GitHub ",r.createElement(t.a,{href:"https://github.com/eclipse-jkube/jkube/pulls",target:"_blank",rel:"nofollow noopener noreferrer"},"pull requests")," from your ",r.createElement(t.strong,null,"own")," fork."),"\n",r.createElement(t.p,null,"All commits must be ",r.createElement(t.a,{href:"https://git-scm.com/docs/git-commit#Documentation/git-commit.txt---signoff",target:"_blank",rel:"nofollow noopener noreferrer"},"signed-off"),"\nby a user that has signed the\n",r.createElement(t.a,{href:"https://www.eclipse.org/legal/ECA.php",target:"_blank",rel:"nofollow noopener noreferrer"},"Eclipse Contributor Agreement"),"."),"\n",r.createElement(t.h4,{id:"trying-out-project-as-end-user",style:{position:"relative"}},r.createElement(t.a,{href:"#trying-out-project-as-end-user","aria-label":"trying out project as end user permalink",className:"anchor before"},r.createElement(t.span,{dangerouslySetInnerHTML:{__html:'<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>'}})),"Trying out project as end user"),"\n",r.createElement(t.p,null,"Before contributing to any Open Source project, it's important to have basic understanding of what the project is about.\nIt is advised to try out the project as an end user. This project is a collection of Maven and Gradle plugins for ",r.createElement(t.a,{href:"https://kubernetes.io/",target:"_blank",rel:"nofollow noopener noreferrer"},"Kubernetes"),"\nand ",r.createElement(t.a,{href:"https://www.redhat.com/en/technologies/cloud-computing/openshift",target:"_blank",rel:"nofollow noopener noreferrer"},"Red Hat OpenShift"),", it's advised to learn about these\ntechnologies if you're interested in seriously contributing to the project."),"\n",r.createElement(t.p,null,"You can read some blogs about project or watch videos on ",r.createElement(t.a,{href:"https://www.youtube.com/@jkube",target:"_blank",rel:"nofollow noopener noreferrer"},"Eclipse JKube YouTube channel")," ."),"\n",r.createElement(t.h4,{id:"finding-an-issue-to-work-on",style:{position:"relative"}},r.createElement(t.a,{href:"#finding-an-issue-to-work-on","aria-label":"finding an issue to work on permalink",className:"anchor before"},r.createElement(t.span,{dangerouslySetInnerHTML:{__html:'<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>'}})),"Finding an issue to work on"),"\n",r.createElement(t.p,null,"You're free to start with any type of contribution, whether it is documentation or some issue you faced while\ntrying out the project. From time to time we create new issues tagged with label ",r.createElement(t.a,{href:"https://github.com/eclipse-jkube/jkube/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22good+first+issue%22",target:"_blank",rel:"nofollow noopener noreferrer"},r.createElement(t.code,null,"good first issue"))," ."),"\n",r.createElement(t.p,null,"If you're contributing for the first time, we advise to start with a ",r.createElement(t.a,{href:"https://github.com/eclipse-jkube/jkube/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Afirst-timers-only",target:"_blank",rel:"nofollow noopener noreferrer"},r.createElement(t.code,null,"first timers only"))," issues."),"\n",r.createElement(t.p,null,"These issues are a great way to getting started with project. They are divided into three categories at the moment."),"\n",r.createElement(t.h5,{id:"first-timers-only-issues",style:{position:"relative"}},r.createElement(t.a,{href:"#first-timers-only-issues","aria-label":"first timers only issues permalink",className:"anchor before"},r.createElement(t.span,{dangerouslySetInnerHTML:{__html:'<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>'}})),"First Timers Only Issues"),"\n",r.createElement(t.p,null,r.createElement(t.a,{href:"https://github.com/eclipse-jkube/jkube/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Afirst-timers-only",target:"_blank",rel:"nofollow noopener noreferrer"},r.createElement(t.code,null,"first timers only"))," issues are usually one line changes that are created for contributors who are contributing to the project for the\nfirst time. Even if you are quite skilled, please consider doing one issue of this category, to get used to the process (e.g PR creation workflow, ECA commit signoff requirement). After that, you\nare invited to move on up to the more difficult tasks, leaving some of the easy tasks to others so they can get involved and achieve change\nthemselves."),"\n",r.createElement(t.p,null,"These issues are aimed for first-time contributors to get acquainted with the project and the Eclipse Foundation contributing policies.\nUsers are only allowed to take one of these issues and are also encouraged to tackle one of these before doing more complex code contributions.\nThese issues are extremely simple to solve. In general, the code changes are already described in the issue.\nThe main purpose is to ensure that contributors have signed an ECA and are familiar with the GitHub pull request procedures."),"\n",r.createElement(t.h5,{id:"good-first-issues",style:{position:"relative"}},r.createElement(t.a,{href:"#good-first-issues","aria-label":"good first issues permalink",className:"anchor before"},r.createElement(t.span,{dangerouslySetInnerHTML:{__html:'<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>'}})),"Good First Issues"),"\n",r.createElement(t.p,null,r.createElement(t.a,{href:"https://github.com/eclipse-jkube/jkube/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22good+first+issue%22",target:"_blank",rel:"nofollow noopener noreferrer"},r.createElement(t.code,null,"good first issue"))," issues are slightly involved issues that are created for contributors that have already contributed to the project.\nThese issues are aimed for users who have already tackled a first-timers-only and would like to continue their contributing journey on the project.\nThese issues are slightly more complicated and will require actual work from the contributor.\nThe main purpose is for contributors to gain confidence while working on the code-base and to keep them engaged in the project."),"\n",r.createElement(t.h5,{id:"help-wanted-issues",style:{position:"relative"}},r.createElement(t.a,{href:"#help-wanted-issues","aria-label":"help wanted issues permalink",className:"anchor before"},r.createElement(t.span,{dangerouslySetInnerHTML:{__html:'<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>'}})),"Help Wanted Issues"),"\n",r.createElement(t.p,null,r.createElement(t.a,{href:"https://github.com/eclipse-jkube/jkube/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22help+wanted%22",target:"_blank",rel:"nofollow noopener noreferrer"},r.createElement(t.code,null,"help wanted"))," issues are more complex issues created to be picked by contributors familiar with codebase."),"\n",r.createElement(t.p,null,"These issues are more complex and are aimed for regular contributors of the project or people who are familiar with the code-base."),"\n",r.createElement(t.h4,{id:"code-reviews",style:{position:"relative"}},r.createElement(t.a,{href:"#code-reviews","aria-label":"code reviews permalink",className:"anchor before"},r.createElement(t.span,{dangerouslySetInnerHTML:{__html:'<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>'}})),"Code reviews"),"\n",r.createElement(t.p,null,"All reviews, including submissions by project members, need to be reviewed before being merged by the project official\n",r.createElement(t.a,{href:"https://projects.eclipse.org/projects/ecd.jkube/who",target:"_blank",rel:"nofollow noopener noreferrer"},"committers"),"."),"\n",r.createElement(t.p,null,"We usually require two approvals in order to merge a pull request. Project members usually review it within a week or two.\nFeel free to notify them in case feedback is not provided on your pull request."),"\n",r.createElement(t.h4,{id:"tests-and-documentation-are-not-optional",style:{position:"relative"}},r.createElement(t.a,{href:"#tests-and-documentation-are-not-optional","aria-label":"tests and documentation are not optional permalink",className:"anchor before"},r.createElement(t.span,{dangerouslySetInnerHTML:{__html:'<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>'}})),"Tests and documentation are not optional"),"\n",r.createElement(t.p,null,"Don't forget to include unit tests in your pull requests along with documentation (Reference information, javadoc, etc.)."),"\n",r.createElement(t.p,null,"Please make sure you have verified project is compiling cleanly when you run existing tests as well:"),"\n",r.createElement(t.pre,null,r.createElement(t.code,{className:"language-shell"},"mvn clean install\n")),"\n",r.createElement(t.h3,{id:"workflow-tips",style:{position:"relative"}},r.createElement(t.a,{href:"#workflow-tips","aria-label":"workflow tips permalink",className:"anchor before"},r.createElement(t.span,{dangerouslySetInnerHTML:{__html:'<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>'}})),"Workflow Tips"),"\n",r.createElement(t.ul,null,"\n",r.createElement(t.li,null,"Please try to work on a single issue at a time."),"\n",r.createElement(t.li,null,"Please provide updates each week or so, otherwise someone else may take the issue."),"\n",r.createElement(t.li,null,"If an issue has an assignee without any update in a week, feel free to notify them that you're interested in working in that issue."),"\n",r.createElement(t.li,null,"If you realize you can't complete a task - please leave a comment on the issue and unassign yourself from the issue."),"\n"),"\n",r.createElement(t.h3,{id:"development-tools",style:{position:"relative"}},r.createElement(t.a,{href:"#development-tools","aria-label":"development tools permalink",className:"anchor before"},r.createElement(t.span,{dangerouslySetInnerHTML:{__html:'<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>'}})),"Development Tools"),"\n",r.createElement(t.p,null,"In order to contribute code to the project, it is recommended to install these tools for smooth development experience:"),"\n",r.createElement(t.ul,null,"\n",r.createElement(t.li,null,r.createElement(t.a,{href:"https://maven.apache.org/",target:"_blank",rel:"nofollow noopener noreferrer"},"Apache Maven")),"\n",r.createElement(t.li,null,"A Java IDE (",r.createElement(t.a,{href:"https://www.jetbrains.com/idea/",target:"_blank",rel:"nofollow noopener noreferrer"},"IntelliJ")," / ",r.createElement(t.a,{href:"https://eclipseide.org/",target:"_blank",rel:"nofollow noopener noreferrer"},"Eclipse"),")"),"\n",r.createElement(t.li,null,"Container tools (",r.createElement(t.a,{href:"https://www.docker.com/",target:"_blank",rel:"nofollow noopener noreferrer"},"Docker")," / ",r.createElement(t.a,{href:"https://podman.io/",target:"_blank",rel:"nofollow noopener noreferrer"},"Podman"),")"),"\n",r.createElement(t.li,null,r.createElement(t.a,{href:"https://minikube.sigs.k8s.io/",target:"_blank",rel:"nofollow noopener noreferrer"},"Minikube")),"\n"),"\n",r.createElement(t.h3,{id:"project-setup",style:{position:"relative"}},r.createElement(t.a,{href:"#project-setup","aria-label":"project setup permalink",className:"anchor before"},r.createElement(t.span,{dangerouslySetInnerHTML:{__html:'<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>'}})),"Project Setup"),"\n",r.createElement(t.h4,{id:"building-project-locally",style:{position:"relative"}},r.createElement(t.a,{href:"#building-project-locally","aria-label":"building project locally permalink",className:"anchor before"},r.createElement(t.span,{dangerouslySetInnerHTML:{__html:'<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>'}})),"Building Project Locally"),"\n",r.createElement(t.p,null,"In order to build the project, you would require to install these first:"),"\n",r.createElement(t.ul,null,"\n",r.createElement(t.li,null,"Install Java SDK 11+ (",r.createElement(t.a,{href:"https://adoptium.net/",target:"_blank",rel:"nofollow noopener noreferrer"},"OpenJDK")," recommended)"),"\n",r.createElement(t.li,null,"Install ",r.createElement(t.a,{href:"https://maven.apache.org/",target:"_blank",rel:"nofollow noopener noreferrer"},"Apache Maven")),"\n"),"\n",r.createElement(t.p,null,"Once you've set these tools, you can compile the project using maven."),"\n",r.createElement(t.p,null,"In order to build project quickly by skipping tests, use this command:"),"\n",r.createElement(t.pre,null,r.createElement(t.code,{className:"language-shell"},"mvn clean install -DskipTests\n")),"\n",r.createElement(t.p,null,"In order to perform complete build by running all unit and integration tests, use this command:"),"\n",r.createElement(t.pre,null,r.createElement(t.code,{className:"language-shell"},"mvn clean install\n")),"\n",r.createElement(t.p,null,"After the build is successful, the artifacts should be available in your local Maven repository ",r.createElement(t.code,null,"$HOME/.m2"),"."),"\n",r.createElement(t.h4,{id:"testing-local-build",style:{position:"relative"}},r.createElement(t.a,{href:"#testing-local-build","aria-label":"testing local build permalink",className:"anchor before"},r.createElement(t.span,{dangerouslySetInnerHTML:{__html:'<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>'}})),"Testing Local Build"),"\n",r.createElement(t.p,null,"In order to try out local build, you can build the project and use the ",r.createElement(t.code,null,"SNAPSHOT")," version in one of the quickstarts."),"\n",r.createElement(t.p,null,"For example, if project version is ",r.createElement(t.code,null,"x.yz-SNAPSHOT"),", you can go to any quickstart in ",r.createElement(t.code,null,"quickstarts/")," directory and change\nplugin version used in quickstart project to use the development version."),"\n",r.createElement(t.p,null,r.createElement(t.strong,null,"With Maven")),"\n",r.createElement(t.pre,null,r.createElement(t.code,{className:"language-shell"},"mvn clean install -DskipTests\n\n# Testing Kubernetes Maven Plugin in quickstarts/maven\ncd quickstarts/maven/spring-boot\nmvn k8s:resource -Djkube.version=x.yz-SNAPSHOT -Pkubernetes\n")),"\n",r.createElement(t.p,null,r.createElement(t.strong,null,"With Gradle")),"\n",r.createElement(t.pre,null,r.createElement(t.code,{className:"language-shell"},"# Testing Kubernetes Gradle Plugin in quickstarts/gradle\ncd quickstarts/gradle/spring-boot\n# Edit build.gradle to change Kubernetes Gradle Plugin version to 'x.yz-SNAPSHOT'\n./gradlew k8sResource\n")),"\n",r.createElement(t.h4,{id:"debugging-plugins",style:{position:"relative"}},r.createElement(t.a,{href:"#debugging-plugins","aria-label":"debugging plugins permalink",className:"anchor before"},r.createElement(t.span,{dangerouslySetInnerHTML:{__html:'<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>'}})),"Debugging Plugins"),"\n",r.createElement(t.h5,{id:"maven",style:{position:"relative"}},r.createElement(t.a,{href:"#maven","aria-label":"maven permalink",className:"anchor before"},r.createElement(t.span,{dangerouslySetInnerHTML:{__html:'<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>'}})),"Maven"),"\n",r.createElement(t.p,null,"In order to debug Kubernetes Maven Plugin, use ",r.createElement(t.code,null,"mvnDebug")," instead of ",r.createElement(t.code,null,"mvn")," to start debug process:"),"\n",r.createElement(t.pre,null,r.createElement(t.code,{className:"language-shell"},"mvnDebug k8s:resource\nPreparing to execute Maven in debug mode\nListening for transport dt_socket at address: 8000\n")),"\n",r.createElement(t.p,null,"After starting this session, you would need to connect to this process from your IDE via remote JVM debugging configuration."),"\n",r.createElement(t.h5,{id:"gradle",style:{position:"relative"}},r.createElement(t.a,{href:"#gradle","aria-label":"gradle permalink",className:"anchor before"},r.createElement(t.span,{dangerouslySetInnerHTML:{__html:'<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>'}})),"Gradle"),"\n",r.createElement(t.p,null,"In order to debug Kubernetes Gradle Plugin, use"),"\n",r.createElement(t.pre,null,r.createElement(t.code,{className:"language-shell"},"./gradlew -Dorg.gradle.debug=true k8sResource\n")),"\n",r.createElement(t.p,null,"After starting this session, you would need to connect to this process from your IDE via remote JVM debugging configuration."),"\n",r.createElement(t.h4,{id:"gitpod",style:{position:"relative"}},r.createElement(t.a,{href:"#gitpod","aria-label":"gitpod permalink",className:"anchor before"},r.createElement(t.span,{dangerouslySetInnerHTML:{__html:'<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>'}})),"GitPod"),"\n",r.createElement(t.p,null,"You can also use ",r.createElement(t.a,{href:"https://gitpod.io",target:"_blank",rel:"nofollow noopener noreferrer"},"Gitpod")," to contribute without install anything on your computer. Click ",r.createElement(t.a,{href:"https://gitpod.io/#https://github.com/eclipse/jkube",target:"_blank",rel:"nofollow noopener noreferrer"},"here")," to start a workspace."),"\n",r.createElement(t.h4,{id:"ide-config-and-code-style",style:{position:"relative"}},r.createElement(t.a,{href:"#ide-config-and-code-style","aria-label":"ide config and code style permalink",className:"anchor before"},r.createElement(t.span,{dangerouslySetInnerHTML:{__html:'<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>'}})),"IDE Config and Code Style"),"\n",r.createElement(t.p,null,"Code formatting is done by the Eclipse code formatter using the configuration files found in the ",r.createElement(t.code,null,"ide-config")," directory."),"\n",r.createElement(t.h5,{id:"eclipse-ide-setup",style:{position:"relative"}},r.createElement(t.a,{href:"#eclipse-ide-setup","aria-label":"eclipse ide setup permalink",className:"anchor before"},r.createElement(t.span,{dangerouslySetInnerHTML:{__html:'<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>'}})),"Eclipse IDE Setup"),"\n",r.createElement(t.p,null,"Open the Preferences window, and then navigate to Java -> Code Style -> Formatter.\nClick Import and then select the ",r.createElement(t.code,null,"eclipse-format.xml")," file in the ",r.createElement(t.code,null,"ide-config")," directory."),"\n",r.createElement(t.p,null,"Next navigate to Java -> Code Style -> Organize Imports.\nClick Import and select the ",r.createElement(t.code,null,"eclipse.importorder")," file in the ",r.createElement(t.code,null,"ide-config")," directory."),"\n",r.createElement(t.h5,{id:"intellij-idea-setup",style:{position:"relative"}},r.createElement(t.a,{href:"#intellij-idea-setup","aria-label":"intellij idea setup permalink",className:"anchor before"},r.createElement(t.span,{dangerouslySetInnerHTML:{__html:'<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>'}})),"IntelliJ IDEA Setup"),"\n",r.createElement(t.p,null,"Open the Preferences window (or Settings depending on your edition), navigate to Plugins and install the\n",r.createElement(t.a,{href:"https://plugins.jetbrains.com/plugin/6546-eclipse-code-formatter",target:"_blank",rel:"nofollow noopener noreferrer"},"Eclipse Code Formatter Plugin")," from the Marketplace."),"\n",r.createElement(t.p,null,"Restart your IDE, open the Preferences (or Settings) window again and navigate to Other Settings -> Eclipse Code Formatter."),"\n",r.createElement(t.p,null,"Select Use the Eclipse Code Formatter, then change the Eclipse Java Formatter Config File to point to the\n",r.createElement(t.code,null,"eclipse-format.xml")," file in the ",r.createElement(t.code,null,"ide-config")," directory."),"\n",r.createElement(t.p,null,"Make sure the Optimize Imports box is ticked, and select the ",r.createElement(t.code,null,"eclipse.importorder")," file as the import order config file."),"\n",r.createElement(t.img,{src:"/jkube/40db5a95d875815a4fddb66504f92f51/intellij-eclipse-code-formatter-settings.png",alt:"IntelliJ Eclipse Code Formatter Settings",title:"Eclipse Code Formatter Plugin"}),"\n",r.createElement(t.h3,{id:"working-on-issue",style:{position:"relative"}},r.createElement(t.a,{href:"#working-on-issue","aria-label":"working on issue permalink",className:"anchor before"},r.createElement(t.span,{dangerouslySetInnerHTML:{__html:'<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>'}})),"Working on Issue"),"\n",r.createElement(t.p,null,"While working on issue, please try to align your changes with existing coding conventions. Here are some examples:"),"\n",r.createElement(t.ul,null,"\n",r.createElement(t.li,null,"When adding a new file, please don't forget to add the license header via ",r.createElement(t.code,null,"mvn -N license:format")),"\n",r.createElement(t.li,null,"Please configure your IDE to not add wildcard imports, we don't use wildcard imports."),"\n",r.createElement(t.li,null,"Please make sure you have verified that project compiles cleanly after running ",r.createElement(t.code,null,"mvn clean install -DskipTests")," (skips tests) and ",r.createElement(t.code,null,"mvn clean install")," (runs all tests)."),"\n",r.createElement(t.li,null,"Please properly squash your pull requests before submitting them."),"\n"),"\n",r.createElement(t.h4,{id:"commit-signoff",style:{position:"relative"}},r.createElement(t.a,{href:"#commit-signoff","aria-label":"commit signoff permalink",className:"anchor before"},r.createElement(t.span,{dangerouslySetInnerHTML:{__html:'<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>'}})),"Commit SignOff"),"\n",r.createElement(t.p,null,"Commits should be atomic and semantic. We use ",r.createElement(t.a,{href:"https://www.conventionalcommits.org/en/v1.0.0/",target:"_blank",rel:"nofollow noopener noreferrer"},"Conventional Commits"),"."),"\n",r.createElement(t.p,null,"Please make sure you have added the ",r.createElement(t.code,null,"Signed-off-by:")," footer in your git commit. In order to do it automatically, use the ",r.createElement(t.code,null,"--signoff")," flag:"),"\n",r.createElement(t.pre,null,r.createElement(t.code,{className:"language-shell"},"git commit --signoff\n")),"\n",r.createElement(t.p,null,"With this command, git would automatically add a footer by reading your name and email from git config."),"\n",r.createElement(t.h3,{id:"documentation",style:{position:"relative"}},r.createElement(t.a,{href:"#documentation","aria-label":"documentation permalink",className:"anchor before"},r.createElement(t.span,{dangerouslySetInnerHTML:{__html:'<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>'}})),"Documentation"),"\n",r.createElement(t.p,null,"Documentation for Maven/Gradle plugins is available at ",r.createElement(t.a,{href:"https://eclipse.dev/jkube/docs/",target:"_blank",rel:"nofollow noopener noreferrer"},"Eclipse JKube Website")," ."),"\n",r.createElement(t.ul,null,"\n",r.createElement(t.li,null,"Documentation for JKube core is present in ",r.createElement(t.a,{href:"https://github.com/eclipse-jkube/jkube/tree/master/jkube-kit/doc",target:"_blank",rel:"nofollow noopener noreferrer"},"jkube-kit/doc")),"\n",r.createElement(t.li,null,"Maven Plugins related documentation is present in ",r.createElement(t.a,{href:"https://github.com/eclipse-jkube/jkube/tree/master/kubernetes-maven-plugin/doc",target:"_blank",rel:"nofollow noopener noreferrer"},"kubernetes-maven-plugin/doc")),"\n",r.createElement(t.li,null,"Gradle Plugins related documentation is present in ",r.createElement(t.a,{href:"https://github.com/eclipse-jkube/jkube/tree/master/gradle-plugin/doc",target:"_blank",rel:"nofollow noopener noreferrer"},"gradle-plugin/doc")),"\n"),"\n",r.createElement(t.p,null,"We convert AsciiDoc to HTML using ",r.createElement(t.a,{href:"https://docs.asciidoctor.org/maven-tools/latest/plugin/introduction/",target:"_blank",rel:"nofollow noopener noreferrer"},"AsciiDoc Maven Plugin"),"."),"\n",r.createElement(t.p,null,"In order to generate documentation for a single module, run this command:"),"\n",r.createElement(t.pre,null,r.createElement(t.code,{className:"language-shell"},"mvn -Phtml package\n# Check Generated Documentation (Open in Browser)\nls target/generated-docs/index.html\ntarget/generated-docs/index.html\n")),"\n",r.createElement(t.p,null,"We also have a bash script to generate documentation for all plugins together. You can use it like this:"),"\n",r.createElement(t.pre,null,r.createElement(t.code,{className:"language-shell"},"sh scripts/generateDoc.sh\n# Check Generated Documentation (Open in Browser)\nls docs-generated/index.html\n")),"\n",r.createElement(t.h3,{id:"frequently-asked-questions",style:{position:"relative"}},r.createElement(t.a,{href:"#frequently-asked-questions","aria-label":"frequently asked questions permalink",className:"anchor before"},r.createElement(t.span,{dangerouslySetInnerHTML:{__html:'<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>'}})),"Frequently Asked Questions"),"\n",r.createElement(t.ul,null,"\n",r.createElement(t.li,null,r.createElement(t.strong,null,"Not able to compile project on Windows. Is there any workaround for this?")),"\n"),"\n",r.createElement(t.p,null,"Our existing test suite is not fully compatible with Windows. Check the ",r.createElement(t.a,{href:"https://github.com/eclipse-jkube/jkube/issues/1338",target:"_blank",rel:"nofollow noopener noreferrer"},"issue for test failures on Windows"),".\nIn order to work around this, you can use ",r.createElement(t.code,null,"-DskipTests")," flag to skip running tests while compiling project using ",r.createElement(t.code,null,"mvn clean install"),". With this workaround, you should\nbe able to load the project in your IDE."))}var i=function(e){void 0===e&&(e={});const{wrapper:t}=Object.assign({},(0,l.ah)(),e.components);return t?r.createElement(t,e,r.createElement(o,e)):o(e)};const s=e=>({pre:e=>{var t,n;let{className:l="",...o}=e;return"code"===(null==o||null===(t=o.children)||void 0===t||null===(n=t.type)||void 0===n?void 0:n.name)?r.createElement(a.dn,o):r.createElement("pre",Object.assign({className:l},o))},code:t=>r.createElement(a.EK,Object.assign({pageContext:e},t))}),c=e=>{let{children:t,pageContext:n}=e;const{locale:o}=n;return r.createElement(l.Zo,{components:s(n)},r.createElement(a.Zn,{locale:o},r.createElement("div",{className:"eclipse-jkube__content"},t)))},u=e=>{let{data:{mdx:{frontmatter:{title:t,description:n}}}}=e;return r.createElement(a.pQ,{title:t,description:n})};function h(e){return r.createElement(c,e,r.createElement(i,e))}},1151:function(e,t,n){n.d(t,{Zo:function(){return i},ah:function(){return a}});var l=n(7294);const r=l.createContext({});function a(e){const t=l.useContext(r);return l.useMemo((()=>"function"==typeof e?e(t):{...t,...e}),[t,e])}const o={};function i({components:e,children:t,disableParentContext:n}){let i;return i=n?"function"==typeof e?e({}):e||o:a(e),l.createElement(r.Provider,{value:i},t)}}}]);
//# sourceMappingURL=component---src-templates-main-jsx-content-file-path-src-content-contributing-index-mdx-3dbdaff67ae0d947bd8e.js.map