docs/development/contributing/index.html in rbcli-0.2.12 vs docs/development/contributing/index.html in rbcli-0.3.0
- old
+ new
@@ -1,33 +1,34 @@
<!DOCTYPE html>
<html lang="en" class="js csstransforms3d">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <meta name="generator" content="Hugo 0.55.6" />
+ <meta name="generator" content="Hugo 0.74.3" />
<meta name="description" content="">
<link rel="icon" href="/rbcli/images/favicon.png" type="image/png">
<title>Contribution Guide :: RBCli Documentation</title>
- <link href="/rbcli/css/nucleus.css?1561087612" rel="stylesheet">
- <link href="/rbcli/css/fontawesome-all.min.css?1561087612" rel="stylesheet">
- <link href="/rbcli/css/hybrid.css?1561087612" rel="stylesheet">
- <link href="/rbcli/css/featherlight.min.css?1561087612" rel="stylesheet">
- <link href="/rbcli/css/perfect-scrollbar.min.css?1561087612" rel="stylesheet">
- <link href="/rbcli/css/auto-complete.css?1561087612" rel="stylesheet">
- <link href="/rbcli/css/atom-one-dark-reasonable.css?1561087612" rel="stylesheet">
- <link href="/rbcli/css/theme.css?1561087612" rel="stylesheet">
- <link href="/rbcli/css/hugo-theme.css?1561087612" rel="stylesheet">
+ <link href="/rbcli/css/nucleus.css?1596148729" rel="stylesheet">
+ <link href="/rbcli/css/fontawesome-all.min.css?1596148729" rel="stylesheet">
+ <link href="/rbcli/css/hybrid.css?1596148729" rel="stylesheet">
+ <link href="/rbcli/css/featherlight.min.css?1596148729" rel="stylesheet">
+ <link href="/rbcli/css/perfect-scrollbar.min.css?1596148729" rel="stylesheet">
+ <link href="/rbcli/css/auto-complete.css?1596148729" rel="stylesheet">
+ <link href="/rbcli/css/atom-one-dark-reasonable.css?1596148729" rel="stylesheet">
+ <link href="/rbcli/css/theme.css?1596148729" rel="stylesheet">
+ <link href="/rbcli/css/hugo-theme.css?1596148729" rel="stylesheet">
- <link href="/rbcli/css/theme-blue.css?1561087612" rel="stylesheet">
+ <link href="/rbcli/css/theme-blue.css?1596148729" rel="stylesheet">
+
- <script src="/rbcli/js/jquery-3.3.1.min.js?1561087612"></script>
+ <script src="/rbcli/js/jquery-3.3.1.min.js?1596148729"></script>
<style>
:root #header + #content > #left > #rlblock_left{
display:none !important;
}
@@ -52,18 +53,18 @@
<label for="search-by"><i class="fas fa-search"></i></label>
<input data-search-input id="search-by" type="search" placeholder="Search...">
<span data-search-clear=""><i class="fas fa-times"></i></span>
</div>
-<script type="text/javascript" src="/rbcli/js/lunr.min.js?1561087612"></script>
-<script type="text/javascript" src="/rbcli/js/auto-complete.js?1561087612"></script>
+<script type="text/javascript" src="/rbcli/js/lunr.min.js?1596148729"></script>
+<script type="text/javascript" src="/rbcli/js/auto-complete.js?1596148729"></script>
<script type="text/javascript">
var baseurl = "https:\/\/akhoury6.github.io\/rbcli\/";
</script>
-<script type="text/javascript" src="/rbcli/js/search.js?1561087612"></script>
+<script type="text/javascript" src="/rbcli/js/search.js?1596148729"></script>
</div>
<div class="highlightable">
@@ -72,10 +73,12 @@
+
+
<li data-nav-id="/rbcli/quick_reference/" title="Quick Reference" class="dd-item
@@ -94,10 +97,12 @@
+
+
<li data-nav-id="/rbcli/tutorial/" title="Tutorial" class="dd-item
@@ -119,10 +124,12 @@
+
+
<li data-nav-id="/rbcli/tutorial/10-getting_started/" title="Getting Started" class="dd-item ">
<a href="/rbcli/tutorial/10-getting_started/">
@@ -138,10 +145,12 @@
+
+
<li data-nav-id="/rbcli/tutorial/20-project_layout/" title="The Project Layout" class="dd-item ">
<a href="/rbcli/tutorial/20-project_layout/">
@@ -157,10 +166,12 @@
+
+
<li data-nav-id="/rbcli/tutorial/30-your_first_command/" title="Your First Command" class="dd-item ">
<a href="/rbcli/tutorial/30-your_first_command/">
@@ -176,10 +187,12 @@
+
+
<li data-nav-id="/rbcli/tutorial/40-options_parameters_and_arguments/" title="Options, Parameters, and Arguments" class="dd-item ">
<a href="/rbcli/tutorial/40-options_parameters_and_arguments/">
@@ -195,10 +208,12 @@
+
+
<li data-nav-id="/rbcli/tutorial/50-publishing/" title="Publishing Your Application" class="dd-item ">
<a href="/rbcli/tutorial/50-publishing/">
@@ -221,10 +236,12 @@
+
+
<li data-nav-id="/rbcli/advanced/" title="Advanced" class="dd-item
@@ -246,10 +263,12 @@
+
+
<li data-nav-id="/rbcli/advanced/automatic_updates/" title="Automatic Updates" class="dd-item ">
<a href="/rbcli/advanced/automatic_updates/">
@@ -265,10 +284,12 @@
+
+
<li data-nav-id="/rbcli/advanced/command_types/" title="Command Types" class="dd-item ">
<a href="/rbcli/advanced/command_types/">
@@ -284,10 +305,12 @@
+
+
<li data-nav-id="/rbcli/advanced/distributed_state_locking/" title="Distributed State and Locking" class="dd-item ">
<a href="/rbcli/advanced/distributed_state_locking/">
@@ -303,10 +326,12 @@
+
+
<li data-nav-id="/rbcli/advanced/hooks/" title="Execution Hooks" class="dd-item ">
<a href="/rbcli/advanced/hooks/">
@@ -322,10 +347,12 @@
+
+
<li data-nav-id="/rbcli/advanced/interactive_commands/" title="Interactive Commands" class="dd-item ">
<a href="/rbcli/advanced/interactive_commands/">
@@ -341,10 +368,12 @@
+
+
<li data-nav-id="/rbcli/advanced/logging/" title="Logging" class="dd-item ">
<a href="/rbcli/advanced/logging/">
@@ -360,10 +389,12 @@
+
+
<li data-nav-id="/rbcli/advanced/remote_execution/" title="Remote Execution" class="dd-item ">
<a href="/rbcli/advanced/remote_execution/">
@@ -379,10 +410,12 @@
+
+
<li data-nav-id="/rbcli/advanced/state_storage/" title="State Storage" class="dd-item ">
<a href="/rbcli/advanced/state_storage/">
@@ -398,10 +431,12 @@
+
+
<li data-nav-id="/rbcli/advanced/user_config_files/" title="User Configuration Files" class="dd-item ">
<a href="/rbcli/advanced/user_config_files/">
@@ -424,10 +459,12 @@
+
+
<li data-nav-id="/rbcli/development/" title="Development" class="dd-item
parent
@@ -449,10 +486,12 @@
+
+
<li data-nav-id="/rbcli/development/contributing/" title="Contribution Guide" class="dd-item active">
<a href="/rbcli/development/contributing/">
@@ -468,10 +507,12 @@
+
+
<li data-nav-id="/rbcli/development/license/" title="License Info" class="dd-item ">
<a href="/rbcli/development/license/">
@@ -487,10 +528,12 @@
+
+
<li data-nav-id="/rbcli/development/code_of_conduct/" title="Code of Conduct" class="dd-item ">
<a href="/rbcli/development/code_of_conduct/">
@@ -506,10 +549,12 @@
+
+
<li data-nav-id="/rbcli/development/changelog/" title="Changelog" class="dd-item ">
<a href="/rbcli/development/changelog/">
@@ -532,10 +577,12 @@
+
+
<li data-nav-id="/rbcli/whoami/" title="My Letter To You" class="dd-item
@@ -583,11 +630,10 @@
</nav>
-
<section id="body">
<div id="overlay"></div>
<div class="padding highlightable">
<div>
@@ -617,32 +663,27 @@
<a href='/rbcli/'></a> > <a href='/rbcli/development/'>Development</a> > Contribution Guide
-
+
-
+
</span>
</div>
<div class="progress">
<div class="wrapper">
<nav id="TableOfContents">
-<ul>
-<li><a href="#develpment-mode">Develpment Mode</a></li>
-<li><a href="#code-acceptance-criteria">Code Acceptance Criteria</a>
-<ul>
-<li><a href="#tabs-not-spaces">Tabs, Not Spaces</a></li>
-<li><a href="#documentation-for-user-features">Documentation for User Features</a></li>
-<li><a href="#deprecations">Deprecations</a></li>
-</ul></li>
-<li><a href="#maintainer-s-notes">Maintainer’s Notes</a></li>
-</ul>
+ <ul>
+ <li><a href="#tabs-not-spaces">Tabs, Not Spaces</a></li>
+ <li><a href="#documentation-for-user-features">Documentation for User Features</a></li>
+ <li><a href="#deprecations">Deprecations</a></li>
+ </ul>
</nav>
</div>
</div>
@@ -662,99 +703,59 @@
-
-
-
<p>Contributing to RBCli is the same as most open source projects:</p>
-
<ol>
<li>Fork the repository</li>
<li>Create your own branch</li>
<li>Submit a pull request when ready</li>
</ol>
-
<p>That’s all there is to it! We’ve also kept our acceptance criteria pretty simple, as you’ll see below. Feel free to submit a pull request even if you don’t meet it if you would like your code or feature to be reviewed first; we do want to be mindful of your time and will review submissions before they are polished.</p>
-
<h1 id="develpment-mode">Develpment Mode</h1>
-
<p>To allow for easy deveopment, Rbcli has a development mode which allows a project to include rbcli from a local folder instead of the default gem path. To use it, add the following to your shell’s profile (typically <code>~/.bash_profile</code> or <code>~/.profile</code>):</p>
-
-<pre><code class="language-bash">export RBCLI_ENV='development'
-export RBCLI_DEVPATH='/path/to/rbcli/lib/rbcli'
-alias rbcli='/path/to/rbcli/exe/rbcli'
-</code></pre>
-
-<h1 id="code-acceptance-criteria">Code Acceptance Criteria</h1>
-
+<div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">export RBCLI_ENV<span style="color:#f92672">=</span><span style="color:#e6db74">'development'</span>
+export RBCLI_DEVPATH<span style="color:#f92672">=</span><span style="color:#e6db74">'/path/to/rbcli/lib/rbcli'</span>
+alias rbcli<span style="color:#f92672">=</span><span style="color:#e6db74">'/path/to/rbcli/exe/rbcli'</span>
+</code></pre></div><h1 id="code-acceptance-criteria">Code Acceptance Criteria</h1>
<h2 id="tabs-not-spaces">Tabs, Not Spaces</h2>
-
<p>Please, and thanks. We all like to use different indentation levels and styles, and this will keep us consistent between editors.</p>
-
<p>For filetypes where tabs are not supported (such as YAML), please stick to using two (2) spaces.</p>
-
<h2 id="documentation-for-user-features">Documentation for User Features</h2>
-
<p>For any modification that alters the way RBCli is used – we’re talking additional features, options, keyword changes, major behavioral changes, and the like – the documentation will need to be updated as well. You’ll be happy to know we designed it to make the process relatively painless.</p>
-
<p>RBCli’s documentation is essentially a collection of markdown files that have been compiled into a static site using <a href="https://www.mkdocs.org">MkDocs</a>. If you already have python and pip on your system, you can install it by running:</p>
-
-<pre><code class="language-bash">pip install mkdocs mkdocs-material
-</code></pre>
-
-<p>You can find the source markdown files in the <code>docs-src/docs</code> folder, and the menu organization in <code>docs-src/mkdocs.yml</code>. To preview your changes on a live site, run:</p>
-
-<pre><code class="language-bash">mkdocs serve
-</code></pre>
-
-<p>Also, don’t forget to update the <strong>Quick Reference Guide</strong> in the <code>README.md</code> file (the main project one) with information about your changes.</p>
-
+<div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">pip install mkdocs mkdocs-material
+</code></pre></div><p>You can find the source markdown files in the <code>docs-src/docs</code> folder, and the menu organization in <code>docs-src/mkdocs.yml</code>. To preview your changes on a live site, run:</p>
+<div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">mkdocs serve
+</code></pre></div><p>Also, don’t forget to update the <strong>Quick Reference Guide</strong> in the <code>README.md</code> file (the main project one) with information about your changes.</p>
<p>Once you’ve completed your edits, run the <code>makesite.sh</code> command to build the actual HTML pages automatically in the <code>docs</code> folder, from where they will be served when live.</p>
-
<h2 id="deprecations">Deprecations</h2>
-
<p>If a feature needs to be deprecated, RBCli has a built-in deprecation message feature. You can leverage it by calling the following code when a deprecated command is called:</p>
-
-<pre><code class="language-ruby">Rbcli::DeprecationWarning.new deprecated_command, message, version_when_code_will_be_removed
-</code></pre>
-
-<p>So, for example:</p>
-
-<pre><code class="language-ruby">Rbcli::DeprecationWarning.new 'Rbcli::Configurate.me--first_run', 'Please use `RBCli::Configurate.hooks` as the parent block instead.', '0.3.0'
-</code></pre>
-
-<p>will display the following message to the user, in red, any any time the application is run:</p>
-
-<pre><code class="language-text">DEPRECATION WRNING: The feature `Rbcli::Configurate.me--post_hook` has been deprecated. Please use `RBCli::Configurate.hooks` as the parent block instead. This feature will be removed in version 0.3.0.
-</code></pre>
-
-<p>Additionally, it will place the same line in the logs using <code>Rbcli.logger.warn</code> if logging is enabled.</p>
-
+<div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-ruby" data-lang="ruby"><span style="color:#66d9ef">Rbcli</span><span style="color:#f92672">::</span><span style="color:#66d9ef">DeprecationWarning</span><span style="color:#f92672">.</span>new deprecated_command, message, version_when_code_will_be_removed
+</code></pre></div><p>So, for example:</p>
+<div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-ruby" data-lang="ruby"><span style="color:#66d9ef">Rbcli</span><span style="color:#f92672">::</span><span style="color:#66d9ef">DeprecationWarning</span><span style="color:#f92672">.</span>new <span style="color:#e6db74">'Rbcli::Configurate.me--first_run'</span>, <span style="color:#e6db74">'Please use `RBCli::Configurate.hooks` as the parent block instead.'</span>, <span style="color:#e6db74">'0.3.0'</span>
+</code></pre></div><p>will display the following message to the user, in red, any any time the application is run:</p>
+<div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-text" data-lang="text">DEPRECATION WRNING: The feature `Rbcli::Configurate.me--post_hook` has been deprecated. Please use `RBCli::Configurate.hooks` as the parent block instead. This feature will be removed in version 0.3.0.
+</code></pre></div><p>Additionally, it will place the same line in the logs using <code>Rbcli.logger.warn</code> if logging is enabled.</p>
<p>If a deprecation warning has been added, please remember to mention it in the pull request so that others can update it later.</p>
-
-<h1 id="maintainer-s-notes">Maintainer’s Notes</h1>
-
+<h1 id="maintainers-notes">Maintainer’s Notes</h1>
<p>To install this gem onto your local machine from source, run <code>bundle exec rake install</code>.</p>
-
<p>To release a new version, follow theese steps:</p>
-
<ol>
<li>Update the version number in <code>version.rb</code></li>
<li>Run <code>bundle exec rake install</code>, which will update <code>gemfile.lock</code> with the correct version and all dependency changes</li>
<li>Run <code>docs-src/makesite.sh</code>, which re-compiles the documentation and pulls in the changelog and quick reference automatically</li>
<li>Commit the above changes to master with a commit message of “vX.X.X” (where X.X.X is the version number), but do not push</li>
<li>Run <code>bundle exec rake release</code>, which will create a git tag for the version, push git commits and tags, and push the <code>.gem</code> file to <a href="https://rubygems.org">rubygems.org</a>.</li>
</ol>
-<footer class=" footline" >
+<footer class="footline">
</footer>
-
</div>
</div>
@@ -1175,23 +1176,22 @@
</section>
<div style="left: -1000px; overflow: scroll; position: absolute; top: -1000px; border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;">
<div style="border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;"></div>
</div>
- <script src="/rbcli/js/clipboard.min.js?1561087612"></script>
- <script src="/rbcli/js/perfect-scrollbar.min.js?1561087612"></script>
- <script src="/rbcli/js/perfect-scrollbar.jquery.min.js?1561087612"></script>
- <script src="/rbcli/js/jquery.sticky.js?1561087612"></script>
- <script src="/rbcli/js/featherlight.min.js?1561087612"></script>
- <script src="/rbcli/js/html5shiv-printshiv.min.js?1561087612"></script>
- <script src="/rbcli/js/highlight.pack.js?1561087612"></script>
+ <script src="/rbcli/js/clipboard.min.js?1596148729"></script>
+ <script src="/rbcli/js/perfect-scrollbar.min.js?1596148729"></script>
+ <script src="/rbcli/js/perfect-scrollbar.jquery.min.js?1596148729"></script>
+ <script src="/rbcli/js/jquery.sticky.js?1596148729"></script>
+ <script src="/rbcli/js/featherlight.min.js?1596148729"></script>
+ <script src="/rbcli/js/highlight.pack.js?1596148729"></script>
<script>hljs.initHighlightingOnLoad();</script>
- <script src="/rbcli/js/modernizr.custom-3.6.0.js?1561087612"></script>
- <script src="/rbcli/js/learn.js?1561087612"></script>
- <script src="/rbcli/js/hugo-learn.js?1561087612"></script>
+ <script src="/rbcli/js/modernizr.custom-3.6.0.js?1596148729"></script>
+ <script src="/rbcli/js/learn.js?1596148729"></script>
+ <script src="/rbcli/js/hugo-learn.js?1596148729"></script>
- <link href="/rbcli/mermaid/mermaid.css?1561087612" rel="stylesheet" />
- <script src="/rbcli/mermaid/mermaid.js?1561087612"></script>
+ <link href="/rbcli/mermaid/mermaid.css?1596148729" rel="stylesheet" />
+ <script src="/rbcli/mermaid/mermaid.js?1596148729"></script>
<script>
mermaid.initialize({ startOnLoad: true });
</script>