<!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>How To Contribute to Pip — pip v0.8.2 documentation</title>
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '0.8.2',
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="top" title="pip v0.8.2 documentation" href="index.html" />
<link rel="prev" title="Configuration" href="configuration.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="configuration.html" title="Configuration"
accesskey="P">previous</a></li>
<li><a href="index.html">pip v0.8.2 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="how-to-contribute-to-pip">
<h1>How To Contribute to Pip<a class="headerlink" href="#how-to-contribute-to-pip" title="Permalink to this headline">¶</a></h1>
<p>All kinds of contributions are welcome - code, tests, documentation,
bug reports, ideas, etc.</p>
<div class="section" id="contributing-with-code">
<span id="id1"></span><h2>Contributing with Code<a class="headerlink" href="#contributing-with-code" title="Permalink to this headline">¶</a></h2>
<div class="section" id="forking-through-github">
<h3>Forking through Github<a class="headerlink" href="#forking-through-github" title="Permalink to this headline">¶</a></h3>
<p>First of all, you need to fork the the official repository, which is
<a class="reference external" href="https://github.com/pypa/pip">https://github.com/pypa/pip</a>.</p>
<p>Log in to Github, go to the <a class="reference external" href="https://github.com/pypa/pip">pip repository page</a>, follow the <strong>fork</strong> link, wait for Github
to copy the repository and then clone your fork, like:</p>
<div class="highlight-python"><pre>$ git clone https://github.com/YOU_USER_NAME/pip</pre>
</div>
<p>Now you can change whatever you want, commit, push to your fork and when your
contribution is done, follow the <strong>pull request</strong> link and send us a request
explaining what you did and why.</p>
</div>
<div class="section" id="all-tests-should-pass">
<h3>All tests should pass<a class="headerlink" href="#all-tests-should-pass" title="Permalink to this headline">¶</a></h3>
<p>Almost all changes to pip should be accompanied by automated tests -
especially ones adding new behavior.
<a class="reference external" href="http://somethingaboutorange.com/mrl/projects/nose/0.11.3/">Nose</a> is used to find and run all tests. Take a look at <a class="reference internal" href="running-tests.html"><em>Running the Tests</em></a>
to see what you need and how you should run the tests.</p>
<p>Before sending us a pull request, please, be sure all tests pass.</p>
</div>
<div class="section" id="using-a-continuous-integration-server">
<h3>Using a Continuous Integration server<a class="headerlink" href="#using-a-continuous-integration-server" title="Permalink to this headline">¶</a></h3>
<p>We have a continuous integration server running all pip related tests at
<a class="reference external" href="http://ci.cloudsilverlining.org/view/pip">http://ci.cloudsilverlining.org/view/pip</a>. But if you want to have your own,
you can learn how to set up a Hudson CI server like that in the
<a class="reference internal" href="ci-server-step-by-step.html"><em>Hudson CI server installation step by step</em></a> page.</p>
</div>
</div>
<div class="section" id="contributing-with-tests">
<h2>Contributing with Tests<a class="headerlink" href="#contributing-with-tests" title="Permalink to this headline">¶</a></h2>
<p>Pip’s test coverage is not as good as we would like, so contributions of
additional tests are welcome. You can contribute these the same way you would
contribute any other kind of code: see the <a class="reference internal" href="#contributing-with-code"><em>Contributing with Code</em></a>
section.</p>
</div>
<div class="section" id="contributing-with-bug-reports">
<h2>Contributing with Bug Reports<a class="headerlink" href="#contributing-with-bug-reports" title="Permalink to this headline">¶</a></h2>
<p>Pip project is hosted at <a class="reference external" href="http://github.com/">Github</a> and uses its issue tracker system.</p>
<p>If you have found a bug and want to report it, go to <a class="reference external" href="https://github.com/pypa/pip/issues">pip issue tracker page</a>,
click <strong>Create new</strong>, add a descriptive
title (so we can easily identify what the bug is) and fill the description box
explaining how you got the bug, what pip version you were using and what is
your operating system, so we can reproduce the bug to try fixing it.</p>
</div>
<div class="section" id="contributing-with-ideas">
<h2>Contributing with Ideas<a class="headerlink" href="#contributing-with-ideas" title="Permalink to this headline">¶</a></h2>
<p>We are always open to new ideas, and we will enjoy yours. You can send
enhancement ideas and proposals via <a class="reference external" href="https://github.com/pypa/pip/issues">pip issue tracker page</a>,
<a class="reference external" href="http://groups.google.com/group/python-virtualenv/">virtualenv mailing list</a>, or #pip channel at freenode.</p>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">How To Contribute to Pip</a><ul>
<li><a class="reference internal" href="#contributing-with-code">Contributing with Code</a><ul>
<li><a class="reference internal" href="#forking-through-github">Forking through Github</a></li>
<li><a class="reference internal" href="#all-tests-should-pass">All tests should pass</a></li>
<li><a class="reference internal" href="#using-a-continuous-integration-server">Using a Continuous Integration server</a></li>
</ul>
</li>
<li><a class="reference internal" href="#contributing-with-tests">Contributing with Tests</a></li>
<li><a class="reference internal" href="#contributing-with-bug-reports">Contributing with Bug Reports</a></li>
<li><a class="reference internal" href="#contributing-with-ideas">Contributing with Ideas</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="configuration.html"
title="previous chapter">Configuration</a></p>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" size="18" />
<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">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="configuration.html" title="Configuration"
>previous</a></li>
<li><a href="index.html">pip v0.8.2 documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2008-2011, The pip developers.
Last updated on Mar 06, 2011.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
</div>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
9a7172747f716d6e5c8eedf7f42e6804
>
files
>
109
