<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>CONTRIBUTING.md - fork/static-web-server @ allow-symlink</title>
<meta name="description" content="CONTRIBUTING.md in fork/static-web-server at allow-symlink.">
<meta property="og:title" content="CONTRIBUTING.md - fork/static-web-server @ allow-symlink">
<meta property="og:description" content="CONTRIBUTING.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> / <span class="cur">CONTRIBUTING.md</span></nav>
<span class="view-stats"><span>1.7 KiB</span><span>33 lines</span></span><span class="actions"><a class="raw" href="/fork/static-web-server/raw/637d21e9d944903511b8f226ac9baca505e25d81/CONTRIBUTING.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>Contributing to The Static Web Server project</h1>
<p>Looking to contribute? You’re welcome!</p>
<h2><a href="/fork/static-web-server/ref/allow-symlink/blob/docs/CODE_OF_CONDUCT.md">Code of Conduct</a></h2>
<p>First, <strong>all</strong> project interactions must follow <a href="/fork/static-web-server/ref/allow-symlink/blob/docs/CODE_OF_CONDUCT.md">the code of conduct</a> to ensure everyone is treated with respect.</p>
<h2><a href="https://github.com/static-web-server/static-web-server/issues/new/choose">Issues</a></h2>
<ul>
<li>Filing an issue is a valuable contribution. Reporting bugs and providing details helps us improve SWS and stay informed about issues we might not have noticed otherwise.</li>
<li><a href="/fork/static-web-server/ref/allow-symlink/blob/SECURITY.md">Security issues</a> has some consideration to take into your account first.</li>
</ul>
<h2><a href="/fork/static-web-server/ref/allow-symlink/blob/docs/PULL_REQUESTS.md">Pull Requests</a></h2>
<p>Consider checking the <a href="https://github.com/static-web-server/static-web-server/issues">list of issues</a> if you want to submit something.</p>
<ul>
<li><a href="/fork/static-web-server/ref/allow-symlink/blob/docs/PULL_REQUESTS.md#submitting-a-pull-request">Submitting a Pull Request</a></li>
<li><a href="/fork/static-web-server/ref/allow-symlink/blob/docs/COMMITS.md">Commit Guidelines</a></li>
</ul>
<h2>Documentation</h2>
<p>Improving SWS documentation greatly helps everyone trying to use it.</p>
<ul>
<li>The main website documentation is hosted in the repository and can be improved by following <a href="https://static-web-server.net/building-from-source/#building-documentation-from-source">the documentation instructions</a>.</li>
<li>The API documentation (rendered at <a href="https://docs.rs/static-web-serve">docs.rs/static-web-server</a>) is stored as rustdoc comments directly in the source.</li>
</ul>
<h2>Help</h2>
<p>Helping others integrate SWS into their workflows is a valuable way to contribute:</p>
<ul>
<li>Answer questions in SWS's Discussions or on our Discord.</li>
<li>Write blog posts about using SWS, contributing features, or debugging issues. Your posts add unique insights and examples that may not fit in the SWS repo, helping more users find solutions and explore new use cases.</li>
</ul>
</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>Contributing to The Static Web Server project</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">Looking to contribute? You’re welcome!</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>[Code of Conduct](./docs/CODE_OF_CONDUCT.md)</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">First, **all** project interactions must follow [the code of conduct](./docs/CODE_OF_CONDUCT.md) to ensure everyone is treated with respect.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"><a-p>##</a-p> <a-tt>[Issues](https://github.com/static-web-server/static-web-server/issues/new/choose)</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"><a-p>- </a-p>Filing an issue is a valuable contribution. Reporting bugs and providing details helps us improve SWS and stay informed about issues we might not have noticed otherwise.</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>[Security issues](./SECURITY.md) has some consideration to take into your account first.</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"><a-p>## </a-p><a-tt>[Pull Requests](./docs/PULL_REQUESTS.md)</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"><a-p>Consider checking the [list of issues](https://github.com/static-web-server/static-web-server/issues) if you want to submit something.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"><a-p>- [Submitting a Pull Request](./docs/PULL_REQUESTS.md#submitting-a-pull-request)</a-p></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>- [Commit Guidelines](./docs/COMMITS.md)</a-p></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"><a-p>## </a-p><a-tt>Documentation</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text"><a-p>Improving SWS documentation greatly helps everyone trying to use it.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text"><a-p>- The main website documentation is hosted in the repository and can be improved by following [the documentation instructions](https://static-web-server.net/building-from-source/#building-documentation-from-source).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text"><a-p>- The API documentation (rendered at [docs.rs/static-web-server](https://docs.rs/static-web-serve)) is stored as rustdoc comments directly in the source.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text"><a-p>## </a-p><a-tt>Help</a-tt></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>Helping others integrate SWS into their workflows is a valuable way to contribute:</a-p></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"><a-p>- Answer questions in SWS&#39;s Discussions or on our Discord.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text"><a-p>- </a-p>Write blog posts about using SWS, contributing features, or debugging issues. Your posts add unique insights and examples that may not fit in the SWS repo, helping more users find solutions and explore new use cases.</span></span></pre></div></div>
</main>
</body>
</html>
