"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[6550],{3905:function(e,t,n){n.d(t,{Zo:function(){return p},kt:function(){return d}});var o=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);t&&(o=o.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,o)}return n}function i(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?a(Object(n),!0).forEach((function(t){r(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):a(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function s(e,t){if(null==e)return{};var n,o,r=function(e,t){if(null==e)return{};var n,o,r={},a=Object.keys(e);for(o=0;o<a.length;o++)n=a[o],t.indexOf(n)>=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(o=0;o<a.length;o++)n=a[o],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var l=o.createContext({}),u=function(e){var t=o.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},p=function(e){var t=u(e.components);return o.createElement(l.Provider,{value:t},e.children)},c="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return o.createElement(o.Fragment,{},t)}},h=o.forwardRef((function(e,t){var n=e.components,r=e.mdxType,a=e.originalType,l=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),c=u(n),h=r,d=c["".concat(l,".").concat(h)]||c[h]||m[h]||a;return n?o.createElement(d,i(i({ref:t},p),{},{components:n})):o.createElement(d,i({ref:t},p))}));function d(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var a=n.length,i=new Array(a);i[0]=h;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[c]="string"==typeof e?e:r,i[1]=s;for(var u=2;u<a;u++)i[u]=n[u];return o.createElement.apply(null,i)}return o.createElement.apply(null,n)}h.displayName="MDXCreateElement"},4808:function(e,t,n){n.r(t),n.d(t,{assets:function(){return p},contentTitle:function(){return l},default:function(){return h},frontMatter:function(){return s},metadata:function(){return u},toc:function(){return c}});var o=n(7462),r=n(3366),a=(n(7294),n(3905)),i=["components"],s={id:"faq-contributing",title:"FAQ: Contributing"},l=void 0,u={unversionedId:"faq-contributing",id:"faq-contributing",title:"FAQ: Contributing",description:"Automated checks on my PR have failed. Do you know what's wrong?",source:"@site/../docs/faq-contributing.md",sourceDirName:".",slug:"/faq-contributing",permalink:"/docs/faq-contributing",draft:!1,editUrl:"https://github.com/OpenAPITools/openapi-generator/edit/master/website/../docs/faq-contributing.md",tags:[],version:"current",lastUpdatedBy:"Frieder Bluemle",lastUpdatedAt:1590937392,formattedLastUpdatedAt:"May 31, 2020",frontMatter:{id:"faq-contributing",title:"FAQ: Contributing"},sidebar:"faq-sidebar",previous:{title:"FAQ: Extending",permalink:"/docs/faq-extending"},next:{title:"FAQ: Generators",permalink:"/docs/faq-generators"}},p={},c=[{value:"Automated checks on my PR have failed. Do you know what&#39;s wrong?",id:"automated-checks-on-my-pr-have-failed-do-you-know-whats-wrong",level:2},{value:"The public petstore server returns status 500, can I run it locally?",id:"the-public-petstore-server-returns-status-500-can-i-run-it-locally",level:2},{value:"Who should I report a security vulnerability to?",id:"who-should-i-report-a-security-vulnerability-to",level:2},{value:"How can I rebase my PR on the latest master?",id:"how-can-i-rebase-my-pr-on-the-latest-master",level:2},{value:"How can I update commits that are not linked to my GitHub account?",id:"how-can-i-update-commits-that-are-not-linked-to-my-github-account",level:2},{value:"Any useful git tips to share?",id:"any-useful-git-tips-to-share",level:2},{value:"How can I submit a PR to fix bugs or make enhancements?",id:"how-can-i-submit-a-pr-to-fix-bugs-or-make-enhancements",level:2}],m={toc:c};function h(e){var t=e.components,n=(0,r.Z)(e,i);return(0,a.kt)("wrapper",(0,o.Z)({},m,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h2",{id:"automated-checks-on-my-pr-have-failed-do-you-know-whats-wrong"},"Automated checks on my PR have failed. Do you know what's wrong?"),(0,a.kt)("p",null,"Please do the following:"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Click on the failed tests and check the log to see what's causing the errors."),(0,a.kt)("li",{parentName:"ul"},"If it's related to connection timeout in downloading dependencies, please restart the CI jobs (which can be done by closing and reopening the PR)"),(0,a.kt)("li",{parentName:"ul"},"If it's some other reason, please tag someone on the ",(0,a.kt)("a",{parentName:"li",href:"/docs/core-team"},"core team")," for assistance.")),(0,a.kt)("h2",{id:"the-public-petstore-server-returns-status-500-can-i-run-it-locally"},"The public petstore server returns status 500, can I run it locally?"),(0,a.kt)("p",null,"Yes, please run the following commands (assuming you've docker installed):"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre"},"docker pull swaggerapi/petstore\ndocker run -d -e SWAGGER_HOST=http://petstore.swagger.io -e SWAGGER_BASE_PATH=/v2 -p 80:8080 swaggerapi/petstore\ndocker ps -a\n")),(0,a.kt)("p",null,"Then add the following to your local ",(0,a.kt)("a",{parentName:"p",href:"https://en.wikipedia.org/wiki/Hosts_%28file%29"},"hosts")," table:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre"},"127.0.0.1    petstore.swagger.io\n")),(0,a.kt)("h2",{id:"who-should-i-report-a-security-vulnerability-to"},"Who should I report a security vulnerability to?"),(0,a.kt)("p",null,"Please contact ",(0,a.kt)("a",{parentName:"p",href:"mailto:team@openapitools.org"},"team@openapitools.org")," with the details and we'll follow up with you."),(0,a.kt)("h2",{id:"how-can-i-rebase-my-pr-on-the-latest-master"},"How can I rebase my PR on the latest master?"),(0,a.kt)("p",null,"Please refer to ",(0,a.kt)("a",{parentName:"p",href:"http://rypress.com/tutorials/git/rebasing"},"http://rypress.com/tutorials/git/rebasing"),', or follow the steps below (assuming the branch for the PR is "fix_issue_9999"):'),(0,a.kt)("ol",null,(0,a.kt)("li",{parentName:"ol"},"git checkout master"),(0,a.kt)("li",{parentName:"ol"},"git pull upstream master (assuming ",(0,a.kt)("inlineCode",{parentName:"li"},"upstream")," is pointing to the official repo)"),(0,a.kt)("li",{parentName:"ol"},"git checkout fix_issue_9999"),(0,a.kt)("li",{parentName:"ol"},"git rebase master"),(0,a.kt)("li",{parentName:"ol"},'Resolve merge conflicts, if any, and run "git commit -a"'),(0,a.kt)("li",{parentName:"ol"},"Rebase done (you may need to add --force when doing ",(0,a.kt)("inlineCode",{parentName:"li"},"git push"),")")),(0,a.kt)("p",null,"(To setup ",(0,a.kt)("inlineCode",{parentName:"p"},"upstream")," pointing to the official repo, please run ",(0,a.kt)("inlineCode",{parentName:"p"},"git remote add upstream  https://github.com/openapitools/openapi-generator.git"),")"),(0,a.kt)("h2",{id:"how-can-i-update-commits-that-are-not-linked-to-my-github-account"},"How can I update commits that are not linked to my GitHub account?"),(0,a.kt)("p",null,"Please refer to ",(0,a.kt)("a",{parentName:"p",href:"https://stackoverflow.com/questions/3042437/how-to-change-the-commit-author-for-one-specific-commit"},"https://stackoverflow.com/questions/3042437/how-to-change-the-commit-author-for-one-specific-commit")," or you can simply add the email address in the commit as your secondary email address in your GitHub account."),(0,a.kt)("h2",{id:"any-useful-git-tips-to-share"},"Any useful git tips to share?"),(0,a.kt)("p",null,"Yes, ",(0,a.kt)("a",{parentName:"p",href:"http://www.alexkras.com/19-git-tips-for-everyday-use/"},"http://www.alexkras.com/19-git-tips-for-everyday-use/")),(0,a.kt)("h2",{id:"how-can-i-submit-a-pr-to-fix-bugs-or-make-enhancements"},"How can I submit a PR to fix bugs or make enhancements?"),(0,a.kt)("p",null,"Visit ",(0,a.kt)("a",{parentName:"p",href:"https://github.com/openapitools/openapi-generator"},"https://github.com/openapitools/openapi-generator"),' and then click on the "Fork" button in the upper right corner. Then in your local machine, run the following (assuming your github ID is "your_user_id")'),(0,a.kt)("p",null,"1) git clone ",(0,a.kt)("a",{parentName:"p",href:"https://github.com/your_user_id/openapi-generator.git"},"https://github.com/your_user_id/openapi-generator.git"),"\n2) cd openapi-generator\n3) git checkout -b fix_issue9999\n4) make changes\n5) git commit -a (you may need to use ",(0,a.kt)("inlineCode",{parentName:"p"},"git add filename")," to add new files)\n6) git push origin fix_issue9999\n7) Visit ",(0,a.kt)("a",{parentName:"p",href:"https://github.com/openapitools/openapi-generator"},"https://github.com/openapitools/openapi-generator")," in your browser and click on the button to file a new PR based on fix_issue9999"))}h.isMDXComponent=!0}}]);