[0398a0c] | 1 | |
---|
| 2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
---|
| 3 | "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
---|
| 4 | |
---|
| 5 | <html xmlns="http://www.w3.org/1999/xhtml"> |
---|
| 6 | <head> |
---|
| 7 | <meta http-equiv="X-UA-Compatible" content="IE=Edge" /> |
---|
| 8 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
---|
| 9 | <title>Development, how to contribute — OpenWorkouts 0.2.0 documentation</title> |
---|
| 10 | <link rel="stylesheet" href="_static/alabaster.css" type="text/css" /> |
---|
| 11 | <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> |
---|
| 12 | <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> |
---|
| 13 | <script type="text/javascript" src="_static/jquery.js"></script> |
---|
| 14 | <script type="text/javascript" src="_static/underscore.js"></script> |
---|
| 15 | <script type="text/javascript" src="_static/doctools.js"></script> |
---|
| 16 | <script type="text/javascript" src="_static/language_data.js"></script> |
---|
| 17 | <link rel="author" title="About these documents" href="about.html" /> |
---|
| 18 | <link rel="index" title="Index" href="genindex.html" /> |
---|
| 19 | <link rel="search" title="Search" href="search.html" /> |
---|
| 20 | <link rel="next" title="OpenWorkouts Changelog" href="CHANGES.html" /> |
---|
| 21 | <link rel="prev" title="Installation instructions" href="install.html" /> |
---|
| 22 | |
---|
| 23 | <link rel="stylesheet" href="_static/custom.css" type="text/css" /> |
---|
| 24 | |
---|
| 25 | |
---|
| 26 | <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" /> |
---|
| 27 | |
---|
| 28 | </head><body> |
---|
| 29 | |
---|
| 30 | |
---|
| 31 | <div class="document"> |
---|
| 32 | <div class="documentwrapper"> |
---|
| 33 | <div class="bodywrapper"> |
---|
| 34 | |
---|
| 35 | |
---|
| 36 | <div class="body" role="main"> |
---|
| 37 | |
---|
| 38 | <div class="section" id="development-how-to-contribute"> |
---|
| 39 | <h1><a class="toc-backref" href="#id1">Development, how to contribute</a><a class="headerlink" href="#development-how-to-contribute" title="Permalink to this headline">¶</a></h1> |
---|
| 40 | <div class="contents topic" id="contents"> |
---|
| 41 | <p class="topic-title first">Contents</p> |
---|
| 42 | <ul class="simple"> |
---|
| 43 | <li><a class="reference internal" href="#development-how-to-contribute" id="id1">Development, how to contribute</a><ul> |
---|
| 44 | <li><a class="reference internal" href="#what-you-need" id="id2">What you need</a></li> |
---|
| 45 | <li><a class="reference internal" href="#how-to-access-the-source-code" id="id3">How to access the source code</a><ul> |
---|
| 46 | <li><a class="reference internal" href="#main-development-site" id="id4">Main development site</a></li> |
---|
| 47 | <li><a class="reference internal" href="#github-mirror" id="id5">Github mirror</a></li> |
---|
| 48 | </ul> |
---|
| 49 | </li> |
---|
| 50 | <li><a class="reference internal" href="#development-workflow" id="id6">Development workflow</a></li> |
---|
| 51 | <li><a class="reference internal" href="#documentation" id="id7">Documentation</a></li> |
---|
| 52 | </ul> |
---|
| 53 | </li> |
---|
| 54 | </ul> |
---|
| 55 | </div> |
---|
| 56 | <div class="section" id="what-you-need"> |
---|
| 57 | <h2><a class="toc-backref" href="#id2">What you need</a><a class="headerlink" href="#what-you-need" title="Permalink to this headline">¶</a></h2> |
---|
| 58 | <p>Apart from the dependencies described in the doc:install:, you will need:</p> |
---|
| 59 | <ol class="arabic simple"> |
---|
| 60 | <li><a class="reference external" href="https://git-scm.com">git</a>. We use it for the version control of OpenWorkouts.</li> |
---|
| 61 | <li><a class="reference external" href="http://lesscss.org">lessc</a>. We use it for writing modular css code (and generate the definitive |
---|
| 62 | css files for OpenWorkouts)</li> |
---|
| 63 | </ol> |
---|
| 64 | </div> |
---|
| 65 | <div class="section" id="how-to-access-the-source-code"> |
---|
| 66 | <h2><a class="toc-backref" href="#id3">How to access the source code</a><a class="headerlink" href="#how-to-access-the-source-code" title="Permalink to this headline">¶</a></h2> |
---|
| 67 | <div class="section" id="main-development-site"> |
---|
| 68 | <h3><a class="toc-backref" href="#id4">Main development site</a><a class="headerlink" href="#main-development-site" title="Permalink to this headline">¶</a></h3> |
---|
| 69 | <p>OpenWorkouts development is tracked in our <a class="reference external" href="https://trac.edgewall.org">trac</a> site:</p> |
---|
| 70 | <p><a class="reference external" href="https://openworkouts.org/trac">https://openworkouts.org/trac</a></p> |
---|
| 71 | <p>which is publicly available for everybody.</p> |
---|
| 72 | <p>From there you can browse the sources within your web browser, get a copy |
---|
| 73 | and access all the development information (tasks, bug reports, milestones, |
---|
| 74 | etc).</p> |
---|
| 75 | <p>If you want to get an account and collaborate, get in touch with us at |
---|
| 76 | <a class="reference external" href="mailto:info%40openworkouts.org">info<span>@</span>openworkouts<span>.</span>org</a>.</p> |
---|
| 77 | </div> |
---|
| 78 | <div class="section" id="github-mirror"> |
---|
| 79 | <h3><a class="toc-backref" href="#id5">Github mirror</a><a class="headerlink" href="#github-mirror" title="Permalink to this headline">¶</a></h3> |
---|
| 80 | <p>We also have a mirror in Github:</p> |
---|
| 81 | <p><a class="reference external" href="https://github.com/openworkouts/OpenWorkouts">https://github.com/openworkouts/OpenWorkouts</a></p> |
---|
| 82 | <p>Changes made to the OpenWorkouts repositories are populated to Github, so you |
---|
| 83 | can grab a copy of the sources from there too (and fork, make pull requests, |
---|
| 84 | etc).</p> |
---|
| 85 | <p>What we don’t have replicated in Github is all the development information |
---|
| 86 | (tasks, bugs, etc).</p> |
---|
| 87 | </div> |
---|
| 88 | </div> |
---|
| 89 | <div class="section" id="development-workflow"> |
---|
| 90 | <h2><a class="toc-backref" href="#id6">Development workflow</a><a class="headerlink" href="#development-workflow" title="Permalink to this headline">¶</a></h2> |
---|
| 91 | <p>We are using the well-known <a class="reference external" href="https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow">git-flow</a> workflow, with some notes:</p> |
---|
| 92 | <ol class="arabic"> |
---|
| 93 | <li><p class="first">The <strong>master</strong> branch is used to keep track of releases</p> |
---|
| 94 | </li> |
---|
| 95 | <li><p class="first">The <strong>current</strong> branch is the branch that keeps the main development |
---|
| 96 | flow/current.</p> |
---|
| 97 | </li> |
---|
| 98 | <li><p class="first">Each time a developer wants to implement a new feature, first the |
---|
| 99 | developer grabs the ticket(s) related to that feature in trac, then |
---|
| 100 | a new branch is created from the <strong>current</strong> branch. Work is done on |
---|
| 101 | that branch, which will be merged back to the <strong>current</strong> branch when |
---|
| 102 | it has been finished.</p> |
---|
| 103 | <p>(more info about this workflow in <a class="reference external" href="https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow">this tutorial</a>, just remember we |
---|
| 104 | use <strong>current</strong> instead of <strong>development</strong> for the main development |
---|
| 105 | branch)</p> |
---|
| 106 | </li> |
---|
| 107 | <li><p class="first">Features are grouped in <strong>milestones</strong>, which can be viewed in trac:</p> |
---|
| 108 | <p><a class="reference external" href="https://openworkouts.org/trac/roadmap">https://openworkouts.org/trac/roadmap</a></p> |
---|
| 109 | <p>Once all tasks/tickets in a milestone are done, a release branch is |
---|
| 110 | created. OpenWorkouts is then fully tested, no more features can be |
---|
| 111 | merged at that time, only bugfixes go into the tree, under that branch.</p> |
---|
| 112 | <p>When testing has finished, the release branch is then merged into the |
---|
| 113 | <strong>master</strong> branch, that branch is tagged and a release is done</p> |
---|
| 114 | </li> |
---|
| 115 | </ol> |
---|
| 116 | <p><strong>Bug reports</strong> are saved into a special milestone:</p> |
---|
| 117 | <p><a class="reference external" href="https://openworkouts.org/trac/milestone/Bug%20reports">https://openworkouts.org/trac/milestone/Bug%20reports</a></p> |
---|
| 118 | <p>When a bug is reported, a developer grabs the ticket containing the bug, |
---|
| 119 | checking which version is affected.</p> |
---|
| 120 | <p>If it affects only a specific version, a hotfix branch for that version is |
---|
| 121 | created (using tags to create a branch from the specific release tag) and |
---|
| 122 | the bugfix is written there.</p> |
---|
| 123 | <p>If it affects all (or several) versions, then the bugfix is developed in a |
---|
| 124 | hotfix branch from current, then it is backported to the previous releases.</p> |
---|
| 125 | <p><strong>Again</strong>, reading <a class="reference external" href="https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow">this tutorial</a> will help you get a better picture of |
---|
| 126 | this workflow (and in case of any questions, just ping us at |
---|
| 127 | <a class="reference external" href="mailto:info%40openworkouts.org">info<span>@</span>openworkouts<span>.</span>org</a>)</p> |
---|
| 128 | </div> |
---|
| 129 | <div class="section" id="documentation"> |
---|
| 130 | <h2><a class="toc-backref" href="#id7">Documentation</a><a class="headerlink" href="#documentation" title="Permalink to this headline">¶</a></h2> |
---|
| 131 | <p>Docs are built using <a class="reference external" href="http://www.sphinx-doc.org/en/master">sphinx</a>, written in <a class="reference external" href="http://docutils.sourceforge.net/rst.html">rst</a> and they are located within the |
---|
| 132 | <strong>docs/</strong> directory of the main OpenWorkouts repo.</p> |
---|
| 133 | </div> |
---|
| 134 | </div> |
---|
| 135 | |
---|
| 136 | |
---|
| 137 | </div> |
---|
| 138 | |
---|
| 139 | </div> |
---|
| 140 | </div> |
---|
| 141 | <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> |
---|
| 142 | <div class="sphinxsidebarwrapper"> |
---|
| 143 | <h1 class="logo"><a href="index.html">OpenWorkouts</a></h1> |
---|
| 144 | |
---|
| 145 | |
---|
| 146 | |
---|
| 147 | |
---|
| 148 | |
---|
| 149 | |
---|
| 150 | |
---|
| 151 | |
---|
| 152 | <h3>Navigation</h3> |
---|
| 153 | <p class="caption"><span class="caption-text">Contents:</span></p> |
---|
| 154 | <ul class="current"> |
---|
| 155 | <li class="toctree-l1"><a class="reference internal" href="about.html">About OpenWorkouts</a></li> |
---|
| 156 | <li class="toctree-l1"><a class="reference internal" href="install.html">Installation instructions</a></li> |
---|
| 157 | <li class="toctree-l1 current"><a class="current reference internal" href="#">Development, how to contribute</a><ul> |
---|
| 158 | <li class="toctree-l2"><a class="reference internal" href="#what-you-need">What you need</a></li> |
---|
| 159 | <li class="toctree-l2"><a class="reference internal" href="#how-to-access-the-source-code">How to access the source code</a></li> |
---|
| 160 | <li class="toctree-l2"><a class="reference internal" href="#development-workflow">Development workflow</a></li> |
---|
| 161 | <li class="toctree-l2"><a class="reference internal" href="#documentation">Documentation</a></li> |
---|
| 162 | </ul> |
---|
| 163 | </li> |
---|
| 164 | <li class="toctree-l1"><a class="reference internal" href="CHANGES.html">OpenWorkouts Changelog</a></li> |
---|
| 165 | <li class="toctree-l1"><a class="reference internal" href="AUTHORS.html">OpenWorkouts Authors and Contributors</a></li> |
---|
| 166 | </ul> |
---|
| 167 | |
---|
| 168 | <div class="relations"> |
---|
| 169 | <h3>Related Topics</h3> |
---|
| 170 | <ul> |
---|
| 171 | <li><a href="index.html">Documentation overview</a><ul> |
---|
| 172 | <li>Previous: <a href="install.html" title="previous chapter">Installation instructions</a></li> |
---|
| 173 | <li>Next: <a href="CHANGES.html" title="next chapter">OpenWorkouts Changelog</a></li> |
---|
| 174 | </ul></li> |
---|
| 175 | </ul> |
---|
| 176 | </div> |
---|
| 177 | <div id="searchbox" style="display: none" role="search"> |
---|
| 178 | <h3>Quick search</h3> |
---|
| 179 | <div class="searchformwrapper"> |
---|
| 180 | <form class="search" action="search.html" method="get"> |
---|
| 181 | <input type="text" name="q" /> |
---|
| 182 | <input type="submit" value="Go" /> |
---|
| 183 | <input type="hidden" name="check_keywords" value="yes" /> |
---|
| 184 | <input type="hidden" name="area" value="default" /> |
---|
| 185 | </form> |
---|
| 186 | </div> |
---|
| 187 | </div> |
---|
| 188 | <script type="text/javascript">$('#searchbox').show(0);</script> |
---|
| 189 | |
---|
| 190 | |
---|
| 191 | |
---|
| 192 | |
---|
| 193 | |
---|
| 194 | |
---|
| 195 | |
---|
| 196 | |
---|
| 197 | </div> |
---|
| 198 | </div> |
---|
| 199 | <div class="clearer"></div> |
---|
| 200 | </div> |
---|
| 201 | <div class="footer"> |
---|
| 202 | ©2019, Borja Lopez Rio. |
---|
| 203 | |
---|
| 204 | | |
---|
| 205 | Powered by <a href="http://sphinx-doc.org/">Sphinx 1.8.4</a> |
---|
| 206 | & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> |
---|
| 207 | |
---|
| 208 | | |
---|
| 209 | <a href="_sources/development.rst.txt" |
---|
| 210 | rel="nofollow">Page source</a> |
---|
| 211 | </div> |
---|
| 212 | |
---|
| 213 | |
---|
| 214 | |
---|
| 215 | |
---|
| 216 | </body> |
---|
| 217 | </html> |
---|