<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>docs/content/semantic-versioning.md - fork/static-web-server @ allow-symlink</title>
<meta name="description" content="docs/content/semantic-versioning.md in fork/static-web-server at allow-symlink.">
<meta property="og:title" content="docs/content/semantic-versioning.md - fork/static-web-server @ allow-symlink">
<meta property="og:description" content="docs/content/semantic-versioning.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="25b1b1c391ab948444fcd2a3b8d90b7bba3c998d">docs: improve feature, versioning pages and remove dead links (#460)</span><span class="snapshot-sha sha" data-commit="25b1b1c391ab948444fcd2a3b8d90b7bba3c998d">25b1b1c</span><time datetime="2024-07-01T23:59:20+02:00" title="2024-07-01 23:59:20 +0200">2024-07-01</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> / <a href="/fork/static-web-server/ref/allow-symlink/tree/docs/content/">content</a> / <span class="cur">semantic-versioning.md</span></nav>
<span class="view-stats"><span>1.0 KiB</span><span>12 lines</span></span><span class="actions"><a class="raw" href="/fork/static-web-server/raw/053b36c9d0822a27f418e2589a3d63e5d25091a4/docs/content/semantic-versioning.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>Semantic Versioning</h1>
<p><strong><code>SWS</code></strong> project adheres to <a href="https://semver.org/">Semantic Versioning</a> (SemVer) for every release like the latest <a href="https://github.com/static-web-server/static-web-server/blob/master/CHANGELOG.md"><code>v2</code></a>.</p>
<p>The project privileges stability, security and performance, so you can rely on a major version like <strong>v2</strong> and expect to get features (minor) and bug/security fixes (patch) without breaking changes.</p>
<h2>Breaking changes for major versions</h2>
<p>Only switches between <em><strong>major</strong></em> versions "could" contain <em>breaking changes</em> or not depending on the particular case.&lt;br&gt;
However, this project tries to keep away from any kind of <em>breaking change</em> possible between <em><strong>major</strong></em> versions. But it still supports and prioritizes <em><strong>"no breaking changes"</strong></em> for <em><strong>minor</strong></em> and <em><strong>patch</strong></em> (bug fixes) versions.</p>
<p>On the other hand, if a <em>breaking change</em> is found to be <em>"strictly necessary"</em> to do. Then a new <em><strong>major</strong></em> version must be promoted as well and users informed accordingly so they can do a seamless transition.</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>Semantic Versioning</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">**`SWS`** project adheres to [Semantic Versioning](https://semver.org/) (SemVer) for every release like the latest [`v2`](https://github.com/static-web-server/static-web-server/blob/master/CHANGELOG.md).</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">The project privileges stability, security and performance, so you can rely on a major version like **v2** and expect to get features (minor) and bug/security fixes (patch) without breaking changes.</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"><a-p>##</a-p> <a-tt>Breaking changes for major versions</a-tt></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">Only switches between ***major*** versions &quot;could&quot; contain *breaking changes* or not depending on the particular case.&lt;br&gt;</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text">However, this project tries to keep away from any kind of _breaking change_ possible between ***major*** versions. But it still supports and prioritizes ***&quot;no breaking changes&quot;*** for ***minor*** and ***patch*** (bug fixes) versions.</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">On the other hand, if a *breaking change* is found to be *&quot;strictly necessary&quot;* to do. Then a new ***major*** version must be promoted as well and users informed accordingly so they can do a seamless transition.</span></span></pre></div></div>
</main>
</body>
</html>
