4d54d076.b81c5c96.js

(window.webpackJsonp=window.webpackJsonp||[]).push([[14],{148:function(e,t,n){"use strict";n.r(t),n.d(t,"frontMatter",(function(){return o})),n.d(t,"metadata",(function(){return l})),n.d(t,"rightToc",(function(){return c})),n.d(t,"default",(function(){return b}));var r=n(2),i=n(9),a=(n(0),n(173)),o={id:"contributing",title:"Contributing"},l={id:"contributing",title:"Contributing",description:"Raspbernetes repositories are Apache 2.0 licensed and accepts contributions via GitHub pull requests. Before contributing, make sure to have read the Code of Conduct.",source:"@site/docs/contributing.md",permalink:"/docs/contributing",editUrl:"https://github.com/raspbernetes/docs/edit/master/website/docs/contributing.md",sidebar:"someSidebar",previous:{title:"Style Guide",permalink:"/docs/styleguide"},next:{title:"Installation",permalink:"/docs/installation"}},c=[{value:"Testing",id:"testing",children:[{value:"Kubernetes",id:"kubernetes",children:[]},{value:"Docker",id:"docker",children:[]},{value:"Ansible",id:"ansible",children:[]}]},{value:"Submitting changes",id:"submitting-changes",children:[]},{value:"Coding conventions",id:"coding-conventions",children:[]}],s={rightToc:c};function b(e){var t=e.components,n=Object(i.a)(e,["components"]);return Object(a.b)("wrapper",Object(r.a)({},s,n,{components:t,mdxType:"MDXLayout"}),Object(a.b)("p",null,"Raspbernetes repositories are ",Object(a.b)("a",Object(r.a)({parentName:"p"},{href:"LICENSE"}),"Apache 2.0")," licensed and accepts contributions via GitHub pull requests. Before contributing, make sure to have read the ",Object(a.b)("a",Object(r.a)({parentName:"p"},{href:"https://github.com/raspbernetes/k8s-cluster-installation/blob/master/CODE_OF_CONDUCT.md"}),"Code of Conduct"),"."),Object(a.b)("p",null,"We welcome contributions to all ",Object(a.b)("a",Object(r.a)({parentName:"p"},{href:"https://github.com/raspbernetes"}),"Raspbernetes")," projects."),Object(a.b)("p",null,"If you haven't already, come find us at ",Object(a.b)("a",Object(r.a)({parentName:"p"},{href:"https://discord.gg/RGvKzVg"}),"Discord"),"."),Object(a.b)("p",null,"Here are some important resources:"),Object(a.b)("ul",null,Object(a.b)("li",{parentName:"ul"},"Bugs or new features? ",Object(a.b)("a",Object(r.a)({parentName:"li"},{href:"https://github.com/raspbernetes/k8s-cluster-installation/issues"}),"Github Issues")," is where to report them"),Object(a.b)("li",{parentName:"ul"},"Discord: k8s@home ",Object(a.b)("a",Object(r.a)({parentName:"li"},{href:"https://discord.gg/RGvKzVg"}),"#general"),". With contributors in both hemispheres, there's probably always someone available.")),Object(a.b)("h2",{id:"testing"},"Testing"),Object(a.b)("h3",{id:"kubernetes"},"Kubernetes"),Object(a.b)("p",null,"All resources created will run through our continuous integration pipeline; It will run:"),Object(a.b)("ul",null,Object(a.b)("li",{parentName:"ul"},"YAML Linting"),Object(a.b)("li",{parentName:"ul"},"Kubeval"),Object(a.b)("li",{parentName:"ul"},"Conftest")),Object(a.b)("h3",{id:"docker"},"Docker"),Object(a.b)("p",null,"All images maintained in our ",Object(a.b)("a",Object(r.a)({parentName:"p"},{href:"https://github.com/raspbernetes/multi-arch-images"}),"multi-arch-images")," repository will run ",Object(a.b)("inlineCode",{parentName:"p"},"hadolint"),"."),Object(a.b)("h3",{id:"ansible"},"Ansible"),Object(a.b)("p",null,"We run ",Object(a.b)("inlineCode",{parentName:"p"},"ansible-lint")," on everything related to Ansible."),Object(a.b)("h2",{id:"submitting-changes"},"Submitting changes"),Object(a.b)("p",null,"Please send a GitHub Pull Request with a clear list of what you've done (read more about ",Object(a.b)("a",Object(r.a)({parentName:"p"},{href:"http://help.github.com/pull-requests/"}),"pull requests"),"). Please follow our coding conventions (below) and make sure all of your commits are atomic (one feature per commit)."),Object(a.b)("p",null,"Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:"),Object(a.b)("p",null,'$ git commit -m "A brief summary of the commit'),Object(a.b)("blockquote",null,Object(a.b)("p",{parentName:"blockquote"},'A paragraph describing what changed and its impact."')),Object(a.b)("p",null,"Always sign-off your commits (",Object(a.b)("inlineCode",{parentName:"p"},"git commit --signoff"),")."),Object(a.b)("h2",{id:"coding-conventions"},"Coding conventions"),Object(a.b)("p",null,"Start reading our code and you'll get the hang of it. We optimize for readability:"),Object(a.b)("ul",null,Object(a.b)("li",{parentName:"ul"},"We indent using two spaces (soft tabs)"),Object(a.b)("li",{parentName:"ul"},"We use YAML with the extension ",Object(a.b)("inlineCode",{parentName:"li"},".yml")),Object(a.b)("li",{parentName:"ul"},"We like to keep ",Object(a.b)("inlineCode",{parentName:"li"},"ansible-lint")," happy and error/warning free."),Object(a.b)("li",{parentName:"ul"},"Always end all files with a newline"),Object(a.b)("li",{parentName:"ul"},"This is open source software. Consider the people who will read your code, and make it look nice for them.")),Object(a.b)("p",null,"It's sort of like driving a car: Perhaps you love doing donuts when you're alone, but with passengers the goal is to make the ride as smooth as possible."),Object(a.b)("p",null,"Thanks,"),Object(a.b)("p",null,"Raspbernetes Team"))}b.isMDXComponent=!0},173:function(e,t,n){"use strict";n.d(t,"a",(function(){return u})),n.d(t,"b",(function(){return d}));var r=n(0),i=n.n(r);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?o(Object(n),!0).forEach((function(t){a(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):o(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function c(e,t){if(null==e)return{};var n,r,i=function(e,t){if(null==e)return{};var n,r,i={},a=Object.keys(e);for(r=0;r<a.length;r++)n=a[r],t.indexOf(n)>=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r<a.length;r++)n=a[r],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var s=i.a.createContext({}),b=function(e){var t=i.a.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},u=function(e){var t=b(e.components);return i.a.createElement(s.Provider,{value:t},e.children)},p={inlineCode:"code",wrapper:function(e){var t=e.children;return i.a.createElement(i.a.Fragment,{},t)}},m=i.a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,a=e.originalType,o=e.parentName,s=c(e,["components","mdxType","originalType","parentName"]),u=b(n),m=r,d=u["".concat(o,".").concat(m)]||u[m]||p[m]||a;return n?i.a.createElement(d,l(l({ref:t},s),{},{components:n})):i.a.createElement(d,l({ref:t},s))}));function d(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var a=n.length,o=new Array(a);o[0]=m;var l={};for(var c in t)hasOwnProperty.call(t,c)&&(l[c]=t[c]);l.originalType=e,l.mdxType="string"==typeof e?e:r,o[1]=l;for(var s=2;s<a;s++)o[s]=n[s];return i.a.createElement.apply(null,o)}return i.a.createElement.apply(null,n)}m.displayName="MDXCreateElement"}}]);