1"use strict";(globalThis.webpackChunkwebsite=globalThis.webpackChunkwebsite||[]).push([[5344],{4319(e,t,n){n.r(t),n.d(t,{assets:()=>a,contentTitle:()=>l,default:()=>h,frontMatter:()=>o,metadata:()=>i,toc:()=>c});const i=JSON.parse('{"id":"contributions","title":"Contributions","description":"Every contribution to make this project better is welcome. Thank you!","source":"@site/versioned_docs/version-v25/contributions.md","sourceDirName":".","slug":"/contributions","permalink":"/documentation/contributions","draft":false,"unlisted":false,"editUrl":"https://github.com/graphql-java/graphql-java-page/edit/master/versioned_docs/version-v25/contributions.md","tags":[],"version":"v25","frontMatter":{"title":"Contributions","date":"2018-09-09T02:52:46.000Z","description":"Every contribution to make this project better is welcome. Thank you!"},"sidebar":"tutorialSidebar","previous":{"title":"Concerns","permalink":"/documentation/concerns"},"next":{"title":"Data fetching","permalink":"/documentation/data-fetching"}}');var s=n(4848),r=n(8453);const o={title:"Contributions",date:new Date("2018-09-09T02:52:46.000Z"),description:"Every contribution to make this project better is welcome. Thank you!"},l="Contributions",a={},c=[{value:"Build and test locally",id:"build-and-test-locally",level:2}];function d(e){const t={a:"a",code:"code",h1:"h1",h2:"h2",header:"header",li:"li",p:"p",pre:"pre",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.header,{children:(0,s.jsx)(t.h1,{id:"contributions",children:"Contributions"})}),"\n",(0,s.jsx)(t.p,{children:"Every contribution to make this project better is welcome: Thank you!"}),"\n",(0,s.jsx)(t.p,{children:"In order to make this as pleasant as possible for everybody involved, here are some tips:"}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsxs)(t.li,{children:["\n",(0,s.jsxs)(t.p,{children:["Respect the ",(0,s.jsx)(t.a,{href:"https://github.com/graphql-java/graphql-java/blob/master/CODE_OF_CONDUCT.md",children:"Code of Conduct"})]}),"\n"]}),"\n",(0,s.jsxs)(t.li,{children:["\n",(0,s.jsx)(t.p,{children:"Before opening an Issue to report a bug, please try the latest development version. It can happen that the problem has been already solved."}),"\n"]}),"\n",(0,s.jsxs)(t.li,{children:["\n",(0,s.jsxs)(t.p,{children:["Please use Markdown to format your comments properly. If you are not familiar with that: ",(0,s.jsx)(t.a,{href:"https://help.github.com/articles/getting-started-with-writing-and-formatting-on-github",children:"Getting started with writing and formatting on GitHub"})]}),"\n"]}),"\n",(0,s.jsxs)(t.li,{children:["\n",(0,s.jsx)(t.p,{children:"For Pull Requests:"}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsxs)(t.li,{children:["\n",(0,s.jsxs)(t.p,{children:["Here are some ",(0,s.jsx)(t.a,{href:"https://github.com/blog/1943-how-to-write-the-perfect-pull-request",children:"general tips"})]}),"\n"]}),"\n",(0,s.jsxs)(t.li,{children:["\n",(0,s.jsxs)(t.p,{children:["Please be as focused and clear as possible and don't mix concerns. This includes refactorings mixed with bug-fixes/features, see ",(0,s.jsx)(t.a,{href:"http://tirania.org/blog/archive/2010/Dec-31.html",children:"Open Source Contribution Etiquette"}),"."]}),"\n"]}),"\n",(0,s.jsxs)(t.li,{children:["\n",(0,s.jsxs)(t.p,{children:["It would be good to add automatic tests. All tests are written in ",(0,s.jsx)(t.a,{href:"http://spockframework.github.io/spock/docs/1.0/index.html",children:"Spock"}),"."]}),"\n"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsx)(t.h2,{id:"build-and-test-locally",children:"Build and test locally"}),"\n",(0,s.jsx)(t.p,{children:"Clone the repo and type"}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-bash",children:"./gradlew build\n"})}),"\n",(0,s.jsxs)(t.p,{children:["In ",(0,s.jsx)(t.code,{children:"build/libs"})," you will find the jar file."]}),"\n",(0,s.jsx)(t.p,{children:"Running the tests:"}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-bash",children:"./gradlew test\n"})}),"\n",(0,s.jsx)(t.p,{children:"Installing in the local Maven repository:"}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-bash",children:"./gradlew install\n"})})]})}function h(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},8453(e,t,n){n.d(t,{R:()=>o,x:()=>l});var i=n(6540);const s={},r=i.createContext(s);function o(e){const t=i.useContext(r);return i.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function l(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),i.createElement(r.Provider,{value:t},e.children)}}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.