Skip to content
This repository has been archived by the owner. It is now read-only.
Permalink
Browse files
Updated documentation.
  • Loading branch information
mooshu1x2 committed Jul 28, 2016
1 parent 8f152ce commit d38b5a80739ca11e2c6632c368a66e5adaac931f
Showing 12 changed files with 279 additions and 299 deletions.
@@ -0,0 +1 @@
.. include:: ../../CONTRIBUTING.rst
@@ -85,6 +85,10 @@ div.sphinxsidebar #searchbox input[type="text"] {
width: 170px;
}

div.sphinxsidebar #searchbox input[type="submit"] {
width: 30px;
}

img {
border: 0;
max-width: 100%;
@@ -31,8 +31,8 @@


<link rel="top" title="UserAle 1.0.0 documentation" href="index.html"/>
<link rel="next" title="UserAle Changelog" href="changelog.html"/>
<link rel="prev" title="UserALE Logger" href="userale.logger.html"/>
<link rel="next" title="&lt;no title&gt;" href="contributing.html"/>
<link rel="prev" title="ALE Library" href="userale.html"/>


<script src="_static/js/modernizr.min.js"></script>
@@ -86,8 +86,7 @@
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quickstart Guide</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="userale.html">API</a></li>
<li class="toctree-l1"><a class="reference internal" href="userale.html#logger">Logger</a></li>
<li class="toctree-l1"><a class="reference internal" href="userale.html">ALE Library</a></li>
</ul>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Authors</a><ul>
@@ -168,10 +167,10 @@ <h2>Additional Staff<a class="headerlink" href="#additional-staff" title="Permal

<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">

<a href="changelog.html" class="btn btn-neutral float-right" title="UserAle Changelog" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="contributing.html" class="btn btn-neutral float-right" title="&lt;no title&gt;" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>


<a href="userale.logger.html" class="btn btn-neutral" title="UserALE Logger" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
<a href="userale.html" class="btn btn-neutral" title="ALE Library" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>

</div>

@@ -32,7 +32,7 @@

<link rel="top" title="UserAle 1.0.0 documentation" href="index.html"/>
<link rel="next" title="License" href="license.html"/>
<link rel="prev" title="Authors" href="authors.html"/>
<link rel="prev" title="&lt;no title&gt;" href="contributing.html"/>


<script src="_static/js/modernizr.min.js"></script>
@@ -86,8 +86,7 @@
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quickstart Guide</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="userale.html">API</a></li>
<li class="toctree-l1"><a class="reference internal" href="userale.html#logger">Logger</a></li>
<li class="toctree-l1"><a class="reference internal" href="userale.html">ALE Library</a></li>
</ul>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="authors.html">Authors</a></li>
@@ -161,7 +160,7 @@ <h2>Version 1.0.0<a class="headerlink" href="#version-1-0-0" title="Permalink to
<a href="license.html" class="btn btn-neutral float-right" title="License" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>


<a href="authors.html" class="btn btn-neutral" title="Authors" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
<a href="contributing.html" class="btn btn-neutral" title="&lt;no title&gt;" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>

</div>

@@ -0,0 +1,255 @@


<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>Contributing to UserAle.pyqt5 &mdash; UserAle 1.0.0 documentation</title>















<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />





<link rel="top" title="UserAle 1.0.0 documentation" href="index.html"/>
<link rel="next" title="UserAle Changelog" href="changelog.html"/>
<link rel="prev" title="Authors" href="authors.html"/>


<script src="_static/js/modernizr.min.js"></script>

</head>

<body class="wy-body-for-nav" role="document">

<div class="wy-grid-for-nav">


<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">



<a href="index.html" class="icon icon-home"> UserAle



</a>




<div class="version">
1.0.0
</div>




<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>


</div>

<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">



<ul>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quickstart Guide</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="userale.html">ALE Library</a></li>
</ul>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="authors.html">Authors</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Contributing to UserAle.pyqt5</a></li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">UserAle Changelog</a></li>
<li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
</ul>



</div>
</div>
</nav>

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">


<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">UserAle</a>
</nav>



<div class="wy-nav-content">
<div class="rst-content">






<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> &raquo;</li>

<li>Contributing to UserAle.pyqt5</li>
<li class="wy-breadcrumbs-aside">



</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">

<div class="section" id="contributing-to-userale-pyqt5">
<h1>Contributing to UserAle.pyqt5<a class="headerlink" href="#contributing-to-userale-pyqt5" title="Permalink to this headline"></a></h1>
<p>Thank you for contributing to the UserAle project!</p>
<p>There are certain procedures that must be followed for all contributions. These
procedures are necessary to allow us to allocate resources for reviewing and
testing your contribution, as well as communicate effectively with you during
the review process.</p>
<ol class="arabic">
<li><p class="first">Create an issue in our JIRA</p>
<blockquote>
<div><p>All changes to UserAle must have corresponding issues in JIRA so the
change can be properly tracked:</p>
<blockquote>
<div><p><a class="reference external" href="https://github.com/draperlaboratory/userale.pyqt5/issues">https://github.com/draperlaboratory/userale.pyqt5/issues</a></p>
</div></blockquote>
<p>If you do not already have an account on GitHub, you will need to create
before creating your new issue.</p>
</div></blockquote>
</li>
<li><p class="first">Make and test your changes locally</p>
<blockquote>
<div><p>The UserAle source is maintained in a git repository hosted on GitHub:</p>
<blockquote>
<div><p><a class="reference external" href="https://github.com/draperlaboratory/userale.pyqt5">https://github.com/draperlaboratory/userale.pyqt5</a></p>
</div></blockquote>
<p>To make your changes, fork the repository and make commits
to a topic branch in your fork. Commits should be made in logical units
and must reference the Git issue number:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span>$ git commit -m &quot;UserAle-123: High-level message describing the changes.&quot;
</pre></div>
</div>
<p>Avoid commits which cover multiple, distinct goals that could (and should)
be handled separately.</p>
<p>If you do not already have an account on GitHub, you will need to create
one before making your changes.</p>
</div></blockquote>
</li>
<li><p class="first">Submit your changes via a pull request on GitHub</p>
<blockquote>
<div><p>Once your changes are ready, submit them by creating a pull request for
the corresponding topic branch you created when you began working on your
changes.</p>
<p>The UserAle team will then review your changes and, if they pass review,
your changes will be merged.</p>
</div></blockquote>
</li>
</ol>
</div>


</div>
</div>
<footer>

<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">

<a href="changelog.html" class="btn btn-neutral float-right" title="UserAle Changelog" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>


<a href="authors.html" class="btn btn-neutral" title="Authors" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>

</div>


<hr/>

<div role="contentinfo">
<p>
&copy; Copyright 2016, The Charles Stark Draper Laboratory..

</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.

</footer>

</div>
</div>

</section>

</div>





<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'1.0.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>





<script type="text/javascript" src="_static/js/theme.js"></script>




<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>


</body>
</html>
@@ -89,6 +89,7 @@
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="authors.html">Authors</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to UserAle.pyqt5</a></li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">UserAle Changelog</a></li>
<li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
</ul>
@@ -163,7 +164,7 @@ <h2>API Reference<a class="headerlink" href="#api-reference" title="Permalink to
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="userale.html">ALE Library</a><ul>
<li class="toctree-l2"><a class="reference internal" href="userale.html#module-userale.ale">UserAle</a></li>
<li class="toctree-l2"><a class="reference internal" href="userale.html#userale">UserAle</a></li>
</ul>
</li>
</ul>
@@ -179,6 +180,7 @@ <h2>Additional Notes<a class="headerlink" href="#additional-notes" title="Permal
<li class="toctree-l2"><a class="reference internal" href="authors.html#additional-staff">Additional Staff</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to UserAle.pyqt5</a></li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">UserAle Changelog</a><ul>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-1-0-0">Version 1.0.0</a></li>
</ul>
@@ -92,8 +92,7 @@
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quickstart Guide</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="userale.html">API</a></li>
<li class="toctree-l1"><a class="reference internal" href="userale.html#logger">Logger</a></li>
<li class="toctree-l1"><a class="reference internal" href="userale.html">ALE Library</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="authors.html">Authors</a></li>
@@ -85,8 +85,7 @@
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quickstart Guide</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="userale.html">API</a></li>
<li class="toctree-l1"><a class="reference internal" href="userale.html#logger">Logger</a></li>
<li class="toctree-l1"><a class="reference internal" href="userale.html">ALE Library</a></li>
</ul>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="authors.html">Authors</a></li>
BIN -95 Bytes (80%) objects.inv
Binary file not shown.
@@ -88,6 +88,7 @@
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="authors.html">Authors</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to UserAle.pyqt5</a></li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">UserAle Changelog</a></li>
<li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
</ul>

Some generated files are not rendered by default. Learn more.

0 comments on commit d38b5a8

Please sign in to comment.