mirror of
https://github.com/OpenAPITools/openapi-generator.git
synced 2025-05-12 20:50:55 +00:00
82 lines
18 KiB
HTML
82 lines
18 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>FAQ: Contributing · OpenAPI Generator</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="<h2><a class="anchor" aria-hidden="true" id="automated-checks-on-my-pr-have-failed-do-you-know-what-s-wrong"></a><a href="#automated-checks-on-my-pr-have-failed-do-you-know-what-s-wrong" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" 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></a>Automated checks on my PR have failed. Do you know what's wrong?</h2>
|
||
"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="FAQ: Contributing · OpenAPI Generator"/><meta property="og:type" content="website"/><meta property="og:url" content="https://openapi-generator.tech/index.html"/><meta property="og:description" content="<h2><a class="anchor" aria-hidden="true" id="automated-checks-on-my-pr-have-failed-do-you-know-what-s-wrong"></a><a href="#automated-checks-on-my-pr-have-failed-do-you-know-what-s-wrong" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" 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></a>Automated checks on my PR have failed. Do you know what's wrong?</h2>
|
||
"/><meta property="og:image" content="https://openapi-generator.tech/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://openapi-generator.tech/img/icons/twitter.svg"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><link rel="alternate" type="application/atom+xml" href="https://openapi-generator.tech/blog/atom.xml" title="OpenAPI Generator Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://openapi-generator.tech/blog/feed.xml" title="OpenAPI Generator Blog RSS Feed"/><script>
|
||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||
|
||
ga('create', 'UA-132927057-1', 'auto');
|
||
ga('send', 'pageview');
|
||
</script><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="/js/code-block-buttons.js"></script><link rel="stylesheet" href="/css/main.css"/></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/mono-logo.svg" alt="OpenAPI Generator"/><h2 class="headerTitleWithLogo">OpenAPI Generator</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/installation" target="_self">Get Started</a></li><li class=""><a href="/docs/generators" target="_self">Generators</a></li><li class=""><a href="/docs/roadmap" target="_self">Roadmap</a></li><li class=""><a href="/team" target="_self">Team</a></li><li class="siteNavGroupActive"><a href="/docs/faq" target="_self">FAQ</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container docsNavContainer" id="docsNav"><nav class="toc"><div class="toggleNav"><section class="navWrapper wrapper"><div class="navBreadcrumb wrapper"><div class="navToggle" id="navToggler"><i></i></div><h2><i>›</i><span>FAQ</span></h2><div class="tocToggler" id="tocToggler"><i class="icon-toc"></i></div></div><div class="navGroups"><div class="navGroup"><h3 class="navGroupCategoryTitle">FAQ</h3><ul><li class="navListItem"><a class="navItem" href="/docs/faq">FAQ: General</a></li><li class="navListItem"><a class="navItem" href="/docs/faq-extending">FAQ: Extending</a></li><li class="navListItem navListItemActive"><a class="navItem" href="/docs/faq-contributing">FAQ: Contributing</a></li><li class="navListItem"><a class="navItem" href="/docs/faq-generators">FAQ: Generators</a></li></ul></div></div></section></div><script>
|
||
document.addEventListener('DOMContentLoaded', function() {
|
||
createToggler('#navToggler', '#docsNav', 'docsSliderActive');
|
||
createToggler('#tocToggler', 'body', 'tocActive');
|
||
|
||
const headings = document.querySelector('.toc-headings');
|
||
headings && headings.addEventListener('click', function(event) {
|
||
if (event.target.tagName === 'A') {
|
||
document.body.classList.remove('tocActive');
|
||
}
|
||
}, false);
|
||
|
||
function createToggler(togglerSelector, targetSelector, className) {
|
||
var toggler = document.querySelector(togglerSelector);
|
||
var target = document.querySelector(targetSelector);
|
||
|
||
if (!toggler) {
|
||
return;
|
||
}
|
||
|
||
toggler.onclick = function(event) {
|
||
event.preventDefault();
|
||
|
||
target.classList.toggle(className);
|
||
};
|
||
}
|
||
});
|
||
</script></nav></div><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 class="postHeaderTitle">FAQ: Contributing</h1></header><article><div><span><h2><a class="anchor" aria-hidden="true" id="automated-checks-on-my-pr-have-failed-do-you-know-what-s-wrong"></a><a href="#automated-checks-on-my-pr-have-failed-do-you-know-what-s-wrong" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" 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></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 class="anchor" aria-hidden="true" id="the-public-petstore-server-returns-status-500-can-i-run-it-locally"></a><a href="#the-public-petstore-server-returns-status-500-can-i-run-it-locally" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" 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></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><code class="hljs">docker pull swaggerapi/petstore
|
||
docker <span class="hljs-builtin-name">run</span> -d -e <span class="hljs-attribute">SWAGGER_HOST</span>=http://petstore.swagger.io -e <span class="hljs-attribute">SWAGGER_BASE_PATH</span>=/v2 -p 80:8080 swaggerapi/petstore
|
||
docker ps -a
|
||
</code></pre>
|
||
<p>Then add the following to your local <a href="https://en.wikipedia.org/wiki/Hosts_%28file%29">hosts</a> table:</p>
|
||
<pre><code class="hljs">127<span class="hljs-selector-class">.0</span><span class="hljs-selector-class">.0</span><span class="hljs-selector-class">.1</span> <span class="hljs-selector-tag">petstore</span><span class="hljs-selector-class">.swagger</span><span class="hljs-selector-class">.io</span>
|
||
</code></pre>
|
||
<h2><a class="anchor" aria-hidden="true" id="who-should-i-report-a-security-vulnerability-to"></a><a href="#who-should-i-report-a-security-vulnerability-to" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" 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></a>Who should I report a security vulnerability to?</h2>
|
||
<p>Please contact <a href="mailto:team@openapitools.org">team@openapitools.org</a> with the details and we'll follow up with you.</p>
|
||
<h2><a class="anchor" aria-hidden="true" id="how-can-i-rebase-my-pr-on-the-latest-master"></a><a href="#how-can-i-rebase-my-pr-on-the-latest-master" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" 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></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 class="anchor" aria-hidden="true" id="how-can-i-update-commits-that-are-not-linked-to-my-github-account"></a><a href="#how-can-i-update-commits-that-are-not-linked-to-my-github-account" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" 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></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 class="anchor" aria-hidden="true" id="any-useful-git-tips-to-share"></a><a href="#any-useful-git-tips-to-share" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" 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></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 class="anchor" aria-hidden="true" id="how-can-i-submit-a-pr-to-fix-bugs-or-make-enhancements"></a><a href="#how-can-i-submit-a-pr-to-fix-bugs-or-make-enhancements" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" 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></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>
|
||
<ol>
|
||
<li>git clone <a href="https://github.com/your_user_id/openapi-generator.git">https://github.com/your_user_id/openapi-generator.git</a></li>
|
||
<li>cd openapi-generator</li>
|
||
<li>git checkout -b fix_issue9999</li>
|
||
<li>make changes</li>
|
||
<li>git commit -a (you may need to use <code>git add filename</code> to add new files)</li>
|
||
<li>git push origin fix_issue9999</li>
|
||
<li>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</li>
|
||
</ol>
|
||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2019-1-18</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/faq-extending"><span class="arrow-prev">← </span><span>FAQ: Extending</span></a><a class="docs-next button" href="/docs/faq-generators"><span>FAQ: Generators</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#automated-checks-on-my-pr-have-failed-do-you-know-what-s-wrong">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">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">Who should I report a security vulnerability to?</a></li><li><a href="#how-can-i-rebase-my-pr-on-the-latest-master">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">How can I update commits that are not linked to my Github account?</a></li><li><a href="#any-useful-git-tips-to-share">Any useful git tips to share?</a></li><li><a href="#how-can-i-submit-a-pr-to-fix-bugs-or-make-enhancements">How can I submit a PR to fix bugs or make enhancements?</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/mono-logo.svg" alt="OpenAPI Generator" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/customization.html">Customizing Generators</a><a href="/docs/en/integrations.html">Workflow Integrations</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="http://stackoverflow.com/questions/tagged/openapi-generator" target="_blank" rel="noreferrer noopener">Stack Overflow</a><a href="https://gitter.im/OpenAPITools/openapi-generator">Chat Room</a><a href="https://twitter.com/oas_generator" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/OpenAPITools/openapi-generator">GitHub Repo</a><a class="github-button" href="https://github.com/OpenAPITools/openapi-generator" data-icon="octicon-star" data-count-href="/OpenAPITools/openapi-generator/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2019 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html> |