<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>docs/PULL_REQUESTS.md - fork/static-web-server @ allow-symlink</title>
<meta name="description" content="docs/PULL_REQUESTS.md in fork/static-web-server at allow-symlink.">
<meta property="og:title" content="docs/PULL_REQUESTS.md - fork/static-web-server @ allow-symlink">
<meta property="og:description" content="docs/PULL_REQUESTS.md in fork/static-web-server at allow-symlink.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="allow-symlink" data-tip="4414610fe1b0370ff0ac415e9367548840584710">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/static-web-server</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/static-web-server</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">Jose Quintana</span><span class="commit-message" data-commit="e1a73c0e1e0b5bea80d8a59e25430eda6b7ea0e7">docs: add contributing, code of conduct and code guidelines pages [skip ci] (#497)</span><span class="snapshot-sha sha" data-commit="e1a73c0e1e0b5bea80d8a59e25430eda6b7ea0e7">e1a73c0</span><time datetime="2024-11-11T23:16:54+01:00" title="2024-11-11 23:16:54 +0100">2024-11-11</time></p>
<header class="topbar"><details class="switcher"><summary>allow-symlink</summary><div class="menu"><strong>branches</strong><a class="current" href="/fork/static-web-server/ref/allow-symlink/">allow-symlink</a><a class="all" href="/fork/static-web-server/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/static-web-server/">static-web-server</a> / <a href="/fork/static-web-server/ref/allow-symlink/tree/docs/">docs</a> / <span class="cur">PULL_REQUESTS.md</span></nav>
<span class="view-stats"><span>2.0 KiB</span><span>49 lines</span></span><span class="actions"><a class="raw" href="/fork/static-web-server/raw/0371acb7c5efee1b9a06e5f5c9b435347ffde3be/docs/PULL_REQUESTS.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered"><h1>Pull Requests</h1>
<p>Pull requests are the way to submit changes to the SWS repository.</p>
<h2>Submitting a Pull Request</h2>
<p>In most cases, it a good idea to discuss a potential change in an
<a href="https://github.com/static-web-server/static-web-server/issues">issue</a>. This will allow other contributors to provide guidance and
feedback <em>before</em> significant code work is done, and can increase the
likelihood of getting the pull request merged.</p>
<h3>Tests</h3>
<p>If the change being proposed alters code (as opposed to only documentation for
example), it is either adding new functionality to SWS or it is fixing
existing, broken functionality. In both of these cases, the pull request should
include one or more tests to ensure that SWS does not regress in the future.</p>
<h3>Commits</h3>
<p>Once code, tests, and documentation have been written, a commit needs to be
made. Following the <a href="/fork/static-web-server/ref/allow-symlink/blob/docs/COMMITS.md">commit guidelines</a> will help with the review
process by making your change easier to understand, and makes it easier for
SWS to produce a valuable changelog with each release.</p>
<p>However, if your message doesn't perfectly match the guidelines, <strong>do not worry!</strong>,
the person that eventually merges can easily fixup the message at that
time.</p>
<h3>Opening the Pull Request</h3>
<p>From within GitHub, open a new pull request from your personal branch.</p>
<p>Once opened, pull requests are usually reviewed within a few days.</p>
<h3>Discuss and Update</h3>
<p>You will probably get feedback or requests for changes to your Pull Request.
This is a big part of the submission process so don't be discouraged! Some
contributors may sign off on the Pull Request right away, others may have more
detailed comments or feedback. This is a necessary part of the process in order
to evaluate whether the changes are correct and necessary.</p>
<p>Any community member can review a PR and you might get conflicting feedback.
Keep an eye out for comments from code owners to provide guidance on
conflicting feedback.</p>
<p>You don't need to close the PR and create a new one to address feedback. You
may simply push new commits to the existing branch.</p>
</section><div class="code-panel"><pre class="code src language-markdown"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-p>#</a-p> <a-tt>Pull Requests</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text">Pull requests are the way to submit changes to the SWS repository.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text"><a-p>##</a-p> <a-tt>Submitting a Pull Request</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text">In most cases, it a good idea to discuss a potential change in an</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text">[issue](https://github.com/static-web-server/static-web-server/issues). This will allow other contributors to provide guidance and</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text">feedback _before_ significant code work is done, and can increase the</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text">likelihood of getting the pull request merged.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"><a-p>###</a-p> <a-tt>Tests</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text">If the change being proposed alters code (as opposed to only documentation for</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text">example), it is either adding new functionality to SWS or it is fixing</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text">existing, broken functionality. In both of these cases, the pull request should</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text">include one or more tests to ensure that SWS does not regress in the future.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text"><a-p>###</a-p> <a-tt>Commits</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text">Once code, tests, and documentation have been written, a commit needs to be</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text">made. Following the [commit guidelines](./COMMITS.md) will help with the review</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text">process by making your change easier to understand, and makes it easier for</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text">SWS to produce a valuable changelog with each release.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text">However, if your message doesn&#39;t perfectly match the guidelines, **do not worry!**,</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text">the person that eventually merges can easily fixup the message at that</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text">time.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text"><a-p>###</a-p> <a-tt>Opening the Pull Request</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text">From within GitHub, open a new pull request from your personal branch.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text">Once opened, pull requests are usually reviewed within a few days.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text"><a-p>###</a-p> <a-tt>Discuss and Update</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</a><span class="code-text">You will probably get feedback or requests for changes to your Pull Request.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text">This is a big part of the submission process so don&#39;t be discouraged! Some</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L40" href="#L40">40</a><span class="code-text">contributors may sign off on the Pull Request right away, others may have more</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L41" href="#L41">41</a><span class="code-text">detailed comments or feedback. This is a necessary part of the process in order</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L42" href="#L42">42</a><span class="code-text">to evaluate whether the changes are correct and necessary.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L43" href="#L43">43</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L44" href="#L44">44</a><span class="code-text">Any community member can review a PR and you might get conflicting feedback.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L45" href="#L45">45</a><span class="code-text">Keep an eye out for comments from code owners to provide guidance on</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L46" href="#L46">46</a><span class="code-text">conflicting feedback.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L47" href="#L47">47</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L48" href="#L48">48</a><span class="code-text">You don&#39;t need to close the PR and create a new one to address feedback. You</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L49" href="#L49">49</a><span class="code-text">may simply push new commits to the existing branch.</span></span></pre></div></div>
</main>
</body>
</html>
