/usr/share/doc/python3-autopilot/html/faq/contribute.html is in python3-autopilot 1.5.1+16.04.20160412-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Contribute — Autopilot 1.5 documentation</title>
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/otto.css" type="text/css" />
<link rel="stylesheet" href="../_static/centertext.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '1.5',
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>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="top" title="Autopilot 1.5 documentation" href="../index.html" />
</head>
<body role="document">
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Autopilot 1.5 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="contribute">
<h1><a class="toc-backref" href="#id1">Contribute</a><a class="headerlink" href="#contribute" title="Permalink to this headline">¶</a></h1>
<div class="contents topic" id="contents">
<p class="topic-title first">Contents</p>
<ul class="simple">
<li><a class="reference internal" href="#contribute" id="id1">Contribute</a><ul>
<li><a class="reference internal" href="#autopilot-contributing" id="id2">Autopilot: Contributing</a><ul>
<li><a class="reference internal" href="#q-how-can-i-contribute-to-autopilot" id="id3">Q. How can I contribute to autopilot?</a></li>
<li><a class="reference internal" href="#q-where-can-i-get-help-support" id="id4">Q. Where can I get help / support?</a></li>
<li><a class="reference internal" href="#q-how-do-i-download-the-code" id="id5">Q. How do I download the code?</a></li>
<li><a class="reference internal" href="#q-how-do-i-submit-the-code-for-a-merge-proposal" id="id6">Q. How do I submit the code for a merge proposal?</a></li>
<li><a class="reference internal" href="#q-how-do-i-list-or-run-the-tests-for-the-autopilot-source-code" id="id7">Q. How do I list or run the tests for the autopilot source code?</a></li>
<li><a class="reference internal" href="#q-which-version-of-python-can-autopilot-use" id="id8">Q. Which version of Python can Autopilot use?</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="section" id="autopilot-contributing">
<h2><a class="toc-backref" href="#id2">Autopilot: Contributing</a><a class="headerlink" href="#autopilot-contributing" title="Permalink to this headline">¶</a></h2>
<div class="section" id="q-how-can-i-contribute-to-autopilot">
<h3><a class="toc-backref" href="#id3">Q. How can I contribute to autopilot?</a><a class="headerlink" href="#q-how-can-i-contribute-to-autopilot" title="Permalink to this headline">¶</a></h3>
<ul>
<li><dl class="first docutils">
<dt>Documentation: We can always use more documentation.</dt>
<dd><ul class="first last simple">
<li>if you don’t know how to submit a merge proposal on launchpad, you can write a <a class="reference external" href="https://bugs.launchpad.net/autopilot/+filebug">bug</a> with new documentation and someone will submit a merge proposal for you. They will give you credit for your documentation in the merge proposal.</li>
</ul>
</dd>
</dl>
</li>
<li><p class="first">New Features: Check out our existing <a class="reference external" href="https://blueprints.launchpad.net/autopilot">Blueprints</a> or create some yourself... Then code!</p>
</li>
<li><p class="first">Test and Fix: No project is perfect, log some <a class="reference external" href="https://bugs.launchpad.net/autopilot/+filebug">bugs</a> or <a class="reference external" href="https://bugs.launchpad.net/autopilot">fix some bugs</a>.</p>
</li>
</ul>
</div>
<div class="section" id="q-where-can-i-get-help-support">
<h3><a class="toc-backref" href="#id4">Q. Where can I get help / support?</a><a class="headerlink" href="#q-where-can-i-get-help-support" title="Permalink to this headline">¶</a></h3>
<p>The developers hang out in the #ubuntu-autopilot IRC channel on irc.freenode.net.</p>
</div>
<div class="section" id="q-how-do-i-download-the-code">
<h3><a class="toc-backref" href="#id5">Q. How do I download the code?</a><a class="headerlink" href="#q-how-do-i-download-the-code" title="Permalink to this headline">¶</a></h3>
<p>Autopilot is using Launchpad and Bazaar for source code hosting. If you’re new to Bazaar, or distributed version control in general, take a look at the <a class="reference external" href="http://doc.bazaar.canonical.com/bzr.dev/en/mini-tutorial/index.html">Bazaar mini-tutorial first.</a></p>
<p>Install bzr open a terminal and type:</p>
<div class="highlight-python"><div class="highlight"><pre>$ sudo apt-get install bzr
</pre></div>
</div>
<p>Download the code:</p>
<div class="highlight-python"><div class="highlight"><pre>$ bzr branch lp:autopilot
</pre></div>
</div>
<p>This will create an autopilot directory and place the latest code there. You can also view the autopilot code <a class="reference external" href="https://launchpad.net/autopilot">on the web</a>.</p>
</div>
<div class="section" id="q-how-do-i-submit-the-code-for-a-merge-proposal">
<h3><a class="toc-backref" href="#id6">Q. How do I submit the code for a merge proposal?</a><a class="headerlink" href="#q-how-do-i-submit-the-code-for-a-merge-proposal" title="Permalink to this headline">¶</a></h3>
<p>After making the desired changes to the code or documentation and making sure the tests still run type:</p>
<div class="highlight-python"><div class="highlight"><pre>$ bzr commit
</pre></div>
</div>
<p>Write a quick one line description of the bug that was fixed or the documentation that was written.</p>
<p>Signup for a <a class="reference external" href="https://help.launchpad.net/YourAccount/NewAccount">launchpad account</a>, if you don’t have one. Then using your launchpad id type:</p>
<div class="highlight-python"><div class="highlight"><pre>$ bzr push lp:~<launchpad-id>/autopilot/<text about merge here>
</pre></div>
</div>
<p>Example:</p>
<div class="highlight-python"><div class="highlight"><pre>$ bzr push lp:~chris.gagnon/autopilot/bug-fix-lp234567
</pre></div>
</div>
<p>All new features should have unit and/or functional test to make sure someone doesn’t remove or break your new code with a future commit.</p>
</div>
<div class="section" id="q-how-do-i-list-or-run-the-tests-for-the-autopilot-source-code">
<span id="listing-source-tests"></span><h3><a class="toc-backref" href="#id7">Q. How do I list or run the tests for the autopilot source code?</a><a class="headerlink" href="#q-how-do-i-list-or-run-the-tests-for-the-autopilot-source-code" title="Permalink to this headline">¶</a></h3>
<p>Running autopilot from the source code root directory (the directory containing
the autopilot/ bin/ docs/ debian/ etc. directories) will use the local copy and
not the system installed version.</p>
<p>An example from branching to running:</p>
<div class="highlight-python"><div class="highlight"><pre>$ bzr branch lp:autopilot ~/src/autopilot/trunk
$ cd ~/src/autopilot/trunk
$ python3 -m autopilot.run list autopilot.tests
Loading tests from: /home/example/src/autopilot/trunk
autopilot.tests.functional.test_ap_apps.ApplicationLaunchTests.test_creating_app_for_non_running_app_fails
autopilot.tests.functional.test_ap_apps.ApplicationLaunchTests.test_creating_app_proxy_for_running_app_not_on_dbus_fails
# .. snip ..
autopilot.tests.unit.test_version_utility_fns.VersionFnTests.test_package_version_returns_none_when_running_from_source
255 total tests.
</pre></div>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">The ‘Loading tests from:’ or ‘Running tests from:’ line will inform
you where autopilot is loading the tests from.</p>
</div>
<p>To run a specific suite or a single test in a suite, be more specific with the
tests path.</p>
<p>For example, running all unit tests:</p>
<div class="highlight-python"><div class="highlight"><pre>$ python3 -m autopilot.run run autopilot.tests.unit
</pre></div>
</div>
<p>For example, running just the ‘InputStackKeyboardTypingTests’ suite:</p>
<div class="highlight-python"><div class="highlight"><pre>$ python3 -m autopilot.run run autopilot.tests.functional.test_input_stack.InputStackKeyboardTypingTests
</pre></div>
</div>
<p>Or running a single test in the ‘test_version_utility_fns’ suite:</p>
<div class="highlight-python"><div class="highlight"><pre>$ python3 -m autopilot.run run autopilot.tests.unit.test_version_utility_fns.VersionFnTests.test_package_version_returns_none_when_running_from_source
</pre></div>
</div>
</div>
<div class="section" id="q-which-version-of-python-can-autopilot-use">
<h3><a class="toc-backref" href="#id8">Q. Which version of Python can Autopilot use?</a><a class="headerlink" href="#q-which-version-of-python-can-autopilot-use" title="Permalink to this headline">¶</a></h3>
<p>Autopilot supports Python 3.4.</p>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../index.html">
<img class="logo" src="../_static/otto-64.png" alt="Logo"/>
</a></p>
<h3><a href="../index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Contribute</a><ul>
<li><a class="reference internal" href="#autopilot-contributing">Autopilot: Contributing</a><ul>
<li><a class="reference internal" href="#q-how-can-i-contribute-to-autopilot">Q. How can I contribute to autopilot?</a></li>
<li><a class="reference internal" href="#q-where-can-i-get-help-support">Q. Where can I get help / support?</a></li>
<li><a class="reference internal" href="#q-how-do-i-download-the-code">Q. How do I download the code?</a></li>
<li><a class="reference internal" href="#q-how-do-i-submit-the-code-for-a-merge-proposal">Q. How do I submit the code for a merge proposal?</a></li>
<li><a class="reference internal" href="#q-how-do-i-list-or-run-the-tests-for-the-autopilot-source-code">Q. How do I list or run the tests for the autopilot source code?</a></li>
<li><a class="reference internal" href="#q-which-version-of-python-can-autopilot-use">Q. Which version of Python can Autopilot use?</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Autopilot 1.5 documentation</a> »</li>
</ul>
</div>
<div class="footer">
<div class=center_text>
<a href="#">Learn how you can contribute!</a> / <a href="https://bugs.launchpad.net/autopilot/+filebug">File a bug</a>
<br/>
</div>
© Copyright 2012-2014, Canonical.
</div>
</body>
</html>
|