forked from loafle/openapi-generator-original
61 lines
18 KiB
HTML
61 lines
18 KiB
HTML
<!doctype html>
|
||
<html lang="en">
|
||
<head>
|
||
<meta charset="UTF-8">
|
||
<meta name="viewport" content="width=device-width">
|
||
<meta name="generator" content="Docusaurus">
|
||
<link rel="preconnect" href="https://www.google-analytics.com">
|
||
<script>window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)},ga.l=+new Date,ga("create","UA-132927057-1","auto"),ga("send","pageview")</script>
|
||
<script async src="https://www.google-analytics.com/analytics.js"></script>
|
||
<link rel="preconnect" href="https://www.google-analytics.com">
|
||
<script>window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)},ga.l=+new Date,ga("create","UA-132927057-1","auto"),ga("send","pageview")</script>
|
||
<script async src="https://www.google-analytics.com/analytics.js"></script>
|
||
<script src="https://buttons.github.io/buttons.js"></script>
|
||
<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script>
|
||
<script src="/js/code-block-buttons.js"></script>
|
||
|
||
<title data-react-helmet="true">FAQ: Contributing</title>
|
||
|
||
<meta data-react-helmet="true" http-equiv="x-ua-compatible" content="ie=edge"><meta data-react-helmet="true" property="og:title" content="OpenAPI Generator · Generate clients, servers, and documentation from OpenAPI 2.0/3.x documents"><meta data-react-helmet="true" property="og:image" content="https://openapi-generator.tech/img/docusaurus.png"><meta data-react-helmet="true" property="twitter:image" content="https://openapi-generator.tech/img/docusaurus.png"><meta data-react-helmet="true" name="twitter:image:alt" content="Image for OpenAPI Generator · Generate clients, servers, and documentation from OpenAPI 2.0/3.x documents"><meta data-react-helmet="true" name="twitter:card" content="summary"><meta data-react-helmet="true" name="description" content="## Automated checks on my PR have failed. Do you know what's wrong?"><meta data-react-helmet="true" property="og:description" content="## Automated checks on my PR have failed. Do you know what's wrong?"><meta data-react-helmet="true" property="og:url" content="https://openapi-generator.tech/docs/faq-contributing">
|
||
|
||
<link data-react-helmet="true" rel="shortcut icon" href="/img/favicon.png">
|
||
|
||
|
||
<link rel="stylesheet" href="/styles.ec5417b5.css">
|
||
|
||
</head>
|
||
<body>
|
||
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}function e(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}var n=window.matchMedia("(prefers-color-scheme: dark)");n.addListener((function(n){null===e()&&t(n.matches?"dark":"")}));var a=e();null!==a?t(a):n.matches&&t("dark")}()</script>
|
||
<div id="__docusaurus">
|
||
<nav class="navbar navbar--light navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><div aria-label="Navigation bar toggle" class="navbar__toggle" role="button" tabindex="0"><svg xmlns="http://www.w3.org/2000/svg" width="30" height="30" viewBox="0 0 30 30" role="img" focusable="false"><title>Menu</title><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></div><a aria-current="page" class="navbar__brand active" href="/"><img class="navbar__logo" src="/img/mono-logo.svg" alt="OpenAPI Tools logo"><strong>OpenAPI Generator</strong></a><a class="navbar__item navbar__link" href="/docs/installation">Getting Started</a><a class="navbar__item navbar__link" href="/docs/generators">Generators</a><a class="navbar__item navbar__link" href="/docs/roadmap">Roadmap</a><a class="navbar__item navbar__link" href="/docs/faq">FAQ</a><a class="navbar__item navbar__link" href="/team">Team</a><a class="navbar__item navbar__link" href="/blog">Blog</a><a class="navbar__item navbar__link" activeclassname="navbar__link--active" to="https://api.openapi-generator.tech" href="https://api.openapi-generator.tech">API</a></div><div class="navbar__items navbar__items--right"><div class="react-toggle react-toggle--disabled displayOnlyInLargeViewport_1gtM"><div class="react-toggle-track"><div class="react-toggle-track-check"><span class="toggle_keGJ moon_1gwN"></span></div><div class="react-toggle-track-x"><span class="toggle_keGJ sun_3CPA"></span></div></div><div class="react-toggle-thumb"></div><input type="checkbox" disabled="" aria-label="Dark mode toggle" class="react-toggle-screenreader-only"></div><div class="navbar__search"><span aria-label="expand searchbar" role="button" class="search-icon" tabindex="0"></span><input type="search" id="search_input_react" placeholder="Search" aria-label="Search" class="navbar__search-input search-bar"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div><div class="navbar-sidebar"><div class="navbar-sidebar__brand"><a aria-current="page" class="navbar__brand active" href="/"><img class="navbar__logo" src="/img/mono-logo.svg" alt="OpenAPI Tools logo"><strong>OpenAPI Generator</strong></a></div><div class="navbar-sidebar__items"><div class="menu"><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" href="/docs/installation">Getting Started</a></li><li class="menu__list-item"><a class="menu__link" href="/docs/generators">Generators</a></li><li class="menu__list-item"><a class="menu__link" href="/docs/roadmap">Roadmap</a></li><li class="menu__list-item"><a class="menu__link" href="/docs/faq">FAQ</a></li><li class="menu__list-item"><a class="menu__link" href="/team">Team</a></li><li class="menu__list-item"><a class="menu__link" href="/blog">Blog</a></li><li class="menu__list-item"><a class="menu__link" activeclassname="navbar__link--active" to="https://api.openapi-generator.tech" href="https://api.openapi-generator.tech">API</a></li></ul></div></div></div></nav><div class="main-wrapper"><div class="docPage_1kjD"><div class="docSidebarContainer_1cYp"><div class="sidebar_1kLs"><div class="menu menu--responsive"><button aria-label="Open Menu" class="button button--secondary button--sm menu__button" type="button"><svg class="sidebarMenuIcon_2vk4" xmlns="http://www.w3.org/2000/svg" height="24" width="24" viewBox="0 0 32 32" role="img" focusable="false"><title>Menu</title><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><ul class="menu__list"><li class="menu__list-item"><a class="menu__link menu__link--sublist menu__link--active" href="#!">FAQ</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" href="/docs/faq">FAQ: General</a></li><li class="menu__list-item"><a class="menu__link" href="/docs/faq-extending">FAQ: Extending</a></li><li class="menu__list-item"><a aria-current="page" class="menu__link menu__link--active" href="/docs/faq-contributing">FAQ: Contributing</a></li><li class="menu__list-item"><a class="menu__link" href="/docs/faq-generators">FAQ: Generators</a></li></ul></li></ul></div></div></div><main class="docMainContainer_FFX1"><div class="padding-vert--lg"><div class="container"><div class="row"><div class="col"><div class="docItemContainer_2cwg"><article><header><h1 class="docTitle_1vWb">FAQ: Contributing</h1></header><div class="markdown"><h2><a aria-hidden="true" tabindex="-1" class="anchor" id="automated-checks-on-my-pr-have-failed-do-you-know-whats-wrong"></a><a aria-hidden="true" tabindex="-1" class="hash-link" href="#automated-checks-on-my-pr-have-failed-do-you-know-whats-wrong" title="Direct link to heading">#</a>Automated checks on my PR have failed. Do you know what's wrong?</h2><p>Please do the following:</p><ul><li>Click on the failed tests and check the log to see what's causing the errors.</li><li>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)</li><li>If it's some other reason, please tag someone on the <a href="/docs/core-team">core team</a> for assistance.</li></ul><h2><a aria-hidden="true" tabindex="-1" class="anchor" id="the-public-petstore-server-returns-status-500-can-i-run-it-locally"></a><a aria-hidden="true" tabindex="-1" class="hash-link" href="#the-public-petstore-server-returns-status-500-can-i-run-it-locally" title="Direct link to heading">#</a>The public petstore server returns status 500, can I run it locally?</h2><p>Yes, please run the following commands (assuming you've docker installed):</p><pre class="mdxCodeBlock_iHAB"><div class="codeBlockWrapper_2QGZ"><pre class="prism-code language-bash codeBlock_19pQ" style="color:#F8F8F2;background-color:#282A36"><div class="token-line" style="color:#F8F8F2"><span class="token plain">docker pull swaggerapi/petstore</span></div><div class="token-line" style="color:#F8F8F2"><span class="token plain">docker run -d -e </span><span class="token assign-left variable" style="color:rgb(189, 147, 249);font-style:italic">SWAGGER_HOST</span><span class="token operator">=</span><span class="token plain">http://petstore.swagger.io -e </span><span class="token assign-left variable" style="color:rgb(189, 147, 249);font-style:italic">SWAGGER_BASE_PATH</span><span class="token operator">=</span><span class="token plain">/v2 -p </span><span class="token number">80</span><span class="token plain">:8080 swaggerapi/petstore</span></div><div class="token-line" style="color:#F8F8F2"><span class="token plain">docker </span><span class="token function" style="color:rgb(80, 250, 123)">ps</span><span class="token plain"> -a</span></div></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_1BYj">Copy</button></div></pre><p>Then add the following to your local <a href="https://en.wikipedia.org/wiki/Hosts_%28file%29">hosts</a> table:</p><pre class="mdxCodeBlock_iHAB"><div class="codeBlockWrapper_2QGZ"><pre class="prism-code language-bash codeBlock_19pQ" style="color:#F8F8F2;background-color:#282A36"><div class="token-line" style="color:#F8F8F2"><span class="token number">127.0</span><span class="token plain">.0.1 petstore.swagger.io</span></div></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_1BYj">Copy</button></div></pre><h2><a aria-hidden="true" tabindex="-1" class="anchor" id="who-should-i-report-a-security-vulnerability-to"></a><a aria-hidden="true" tabindex="-1" class="hash-link" href="#who-should-i-report-a-security-vulnerability-to" title="Direct link to heading">#</a>Who should I report a security vulnerability to?</h2><p>Please contact team@openapitools.org with the details and we'll follow up with you.</p><h2><a aria-hidden="true" tabindex="-1" class="anchor" id="how-can-i-rebase-my-pr-on-the-latest-master"></a><a aria-hidden="true" tabindex="-1" class="hash-link" href="#how-can-i-rebase-my-pr-on-the-latest-master" title="Direct link to heading">#</a>How can I rebase my PR on the latest master?</h2><p>Please refer to <a href="http://rypress.com/tutorials/git/rebasing">http://rypress.com/tutorials/git/rebasing</a>, or follow the steps below (assuming the branch for the PR is "fix_issue_9999"):</p><ol><li>git checkout master</li><li>git pull upstream master (assuming <code>upstream</code> is pointing to the official repo)</li><li>git checkout fix_issue_9999</li><li>git rebase master</li><li>Resolve merge conflicts, if any, and run "git commit -a"</li><li>Rebase done (you may need to add --force when doing <code>git push</code>)</li></ol><p>(To setup <code>upstream</code> pointing to the official repo, please run <code>git remote add upstream https://github.com/openapitools/openapi-generator.git</code>)</p><h2><a aria-hidden="true" tabindex="-1" class="anchor" id="how-can-i-update-commits-that-are-not-linked-to-my-github-account"></a><a aria-hidden="true" tabindex="-1" class="hash-link" href="#how-can-i-update-commits-that-are-not-linked-to-my-github-account" title="Direct link to heading">#</a>How can I update commits that are not linked to my GitHub account?</h2><p>Please refer to <a 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</a> or you can simply add the email address in the commit as your secondary email address in your GitHub account.</p><h2><a aria-hidden="true" tabindex="-1" class="anchor" id="any-useful-git-tips-to-share"></a><a aria-hidden="true" tabindex="-1" class="hash-link" href="#any-useful-git-tips-to-share" title="Direct link to heading">#</a>Any useful git tips to share?</h2><p>Yes, <a href="http://www.alexkras.com/19-git-tips-for-everyday-use/">http://www.alexkras.com/19-git-tips-for-everyday-use/</a></p><h2><a aria-hidden="true" tabindex="-1" class="anchor" id="how-can-i-submit-a-pr-to-fix-bugs-or-make-enhancements"></a><a aria-hidden="true" tabindex="-1" class="hash-link" href="#how-can-i-submit-a-pr-to-fix-bugs-or-make-enhancements" title="Direct link to heading">#</a>How can I submit a PR to fix bugs or make enhancements?</h2><p>Visit <a href="https://github.com/openapitools/openapi-generator">https://github.com/openapitools/openapi-generator</a> 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")</p><p>1) git clone <a href="https://github.com/your_user_id/openapi-generator.git">https://github.com/your_user_id/openapi-generator.git</a>
|
||
2) cd openapi-generator
|
||
3) git checkout -b fix_issue9999
|
||
4) make changes
|
||
5) git commit -a (you may need to use <code>git add filename</code> to add new files)
|
||
6) git push origin fix_issue9999
|
||
7) Visit <a href="https://github.com/openapitools/openapi-generator">https://github.com/openapitools/openapi-generator</a> in your browser and click on the button to file a new PR based on fix_issue9999</p></div></article><div class="margin-vert--xl"><div class="row"><div class="col"><a href="https://github.com/OpenAPITools/openapi-generator/edit/master/website/../docs/faq-contributing.md" target="_blank" rel="noreferrer noopener"><svg fill="currentColor" height="1.2em" width="1.2em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 40 40" style="margin-right:0.3em;vertical-align:sub"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col text--right"><em><small>Last updated on <time datetime="2020-11-28T07:00:23.000Z" class="docLastUpdatedAt_1sqk">2020-11-28</time> by <strong>Ülgen Sarıkavak</strong></small></em></div></div></div><div class="margin-vert--lg"><nav class="pagination-nav"><div class="pagination-nav__item"><a class="pagination-nav__link" href="/docs/faq-extending"><h5 class="pagination-nav__link--sublabel">Previous</h5><h4 class="pagination-nav__link--label">« FAQ: Extending</h4></a></div><div class="pagination-nav__item pagination-nav__item--next"><a class="pagination-nav__link" href="/docs/faq-generators"><h5 class="pagination-nav__link--sublabel">Next</h5><h4 class="pagination-nav__link--label">FAQ: Generators »</h4></a></div></nav></div></div></div><div class="col col--3"><div class="tableOfContents_TbNY"><ul class="contents contents__left-border"><li><a href="#automated-checks-on-my-pr-have-failed-do-you-know-whats-wrong" class="contents__link">Automated checks on my PR have failed. Do you know what's wrong?</a></li><li><a href="#the-public-petstore-server-returns-status-500-can-i-run-it-locally" class="contents__link">The public petstore server returns status 500, can I run it locally?</a></li><li><a href="#who-should-i-report-a-security-vulnerability-to" class="contents__link">Who should I report a security vulnerability to?</a></li><li><a href="#how-can-i-rebase-my-pr-on-the-latest-master" class="contents__link">How can I rebase my PR on the latest master?</a></li><li><a href="#how-can-i-update-commits-that-are-not-linked-to-my-github-account" class="contents__link">How can I update commits that are not linked to my GitHub account?</a></li><li><a href="#any-useful-git-tips-to-share" class="contents__link">Any useful git tips to share?</a></li><li><a href="#how-can-i-submit-a-pr-to-fix-bugs-or-make-enhancements" class="contents__link">How can I submit a PR to fix bugs or make enhancements?</a></li></ul></div></div></div></div></div></main></div></div><footer class="footer footer--dark"><div class="container"><div class="row footer__links"><div class="col footer__col"><h4 class="footer__title">Docs</h4><ul class="footer__items"><li class="footer__item"><a class="footer__link-item" href="/docs/customization">Customizing Generators</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/installation">Installation</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/integrations">Workflow Integrations</a></li></ul></div><div class="col footer__col"><h4 class="footer__title">Community</h4><ul class="footer__items"><li class="footer__item"><a class="footer__link-item" href="/users">User Showcase</a></li><li class="footer__item"><a class="footer__link-item" target="_blank" rel="noopener noreferrer" href="https://stackoverflow.com/questions/tagged/openapi-generator">Stack Overflow</a></li><li class="footer__item"><a class="footer__link-item" target="_blank" rel="noopener noreferrer" href="https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM">Chat Room</a></li><li class="footer__item"><a class="footer__link-item" target="_blank" rel="noopener noreferrer" href="https://twitter.com/oas_generator">Twitter</a></li></ul></div><div class="col footer__col"><h4 class="footer__title">More</h4><ul class="footer__items"><li class="footer__item"><a class="footer__link-item" href="/blog">Blog</a></li><li class="footer__item"><a class="footer__link-item" target="_blank" rel="noopener noreferrer" href="https://github.com/OpenAPITools/openapi-generator">GitHub</a></li></ul></div></div><div class="text--center"><div class="margin-bottom--sm"><a href="https://openapi-generator.tech/" target="_blank" rel="noopener noreferrer" class="footerLogoLink_1Wg7"><img class="footer__logo" alt="OpenAPI Tools" src="/img/mono-logo.svg"></a></div>Copyright © 2020 OpenAPI-Generator Contributors (https://openapi-generator.tech)</div></div></footer>
|
||
</div>
|
||
|
||
<script src="/styles.8ca507f6.js"></script>
|
||
|
||
<script src="/runtime~main.f67870b6.js"></script>
|
||
|
||
<script src="/main.e63a9028.js"></script>
|
||
|
||
<script src="/1.fea3cf13.js"></script>
|
||
|
||
<script src="/2.312ccecd.js"></script>
|
||
|
||
<script src="/3.7a8bc6c7.js"></script>
|
||
|
||
<script src="/1be78505.b9ef759e.js"></script>
|
||
|
||
<script src="/20ac7829.25126d58.js"></script>
|
||
|
||
<script src="/17896441.42c7a3f9.js"></script>
|
||
|
||
<script src="/5f7cf4b7.b6ba03e3.js"></script>
|
||
|
||
|
||
</body>
|
||
</html> |