/usr/share/doc/python-django-modeltranslation/html/contribute.html is in python-django-modeltranslation-doc 0.12.2-1.
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 | <!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 — django-modeltranslation 0.12.2 documentation</title>
<link rel="stylesheet" href="_static/classic.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.12.2',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</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="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Related Projects" href="related_projects.html" />
<link rel="prev" title="Caveats" href="caveats.html" />
</head>
<body>
<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="related_projects.html" title="Related Projects"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="caveats.html" title="Caveats"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">django-modeltranslation 0.12.2 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="how-to-contribute">
<span id="contribute"></span><h1>How to Contribute<a class="headerlink" href="#how-to-contribute" title="Permalink to this headline">¶</a></h1>
<p>There are various ways how you can contribute to the project.</p>
<div class="section" id="contributing-code">
<h2>Contributing Code<a class="headerlink" href="#contributing-code" title="Permalink to this headline">¶</a></h2>
<p>The preferred way for code contributions are pull requests at <a class="reference external" href="https://github.com/deschler/django-modeltranslation">Github</a>, usually
created against master.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">In order to be properly blamed for a contribution, please verify that the
email you commit with is connected to your Github account (see
<a class="reference external" href="https://help.github.com/articles/why-are-my-commits-linked-to-the-wrong-user">help.github.com</a> for details).</p>
</div>
<div class="section" id="coding-style">
<h3>Coding Style<a class="headerlink" href="#coding-style" title="Permalink to this headline">¶</a></h3>
<p>Please make sure that your code follows the <a class="reference external" href="http://www.python.org/dev/peps/pep-0008/">PEP 8</a> style guide. The only
exception we make is to allow a maximum line length of 100. Furthermore
your code has to validate against <a class="reference external" href="https://pypi.python.org/pypi/pyflakes">pyflakes</a>. It is recommended to use
<a class="reference external" href="https://pypi.python.org/pypi/flake8">flake8</a> which combines all the checks:</p>
<div class="highlight-console"><div class="highlight"><pre><span></span><span class="gp">$</span> flake8 --max-line-length<span class="o">=</span><span class="m">100</span> modeltranslation
</pre></div>
</div>
<p>The <code class="docutils literal"><span class="pre">#NOQA</span></code> mark added by <a class="reference external" href="https://pypi.python.org/pypi/flake8">flake8</a> should be used sparsely.</p>
</div>
<div class="section" id="django-and-python-versions">
<h3>Django and Python Versions<a class="headerlink" href="#django-and-python-versions" title="Permalink to this headline">¶</a></h3>
<p>We always try to support <strong>at least</strong> the two latest major versions of Django,
as well as Django’s development version. While we can not guarantee the latter
to be supported in early development stages of a new Django version, we aim
to achieve support once it has seen its first release candidate.</p>
<p>The supported Python versions can be derived from the supported Django versions.
Example (from the past) where we support Python 2.5, 2.6 and 2.7:</p>
<blockquote>
<div><ul class="simple">
<li>Django 1.3 (old stable) supports Python 2.5, 2.6, 2.7</li>
<li>Django 1.4 (current stable) supports Python 2.5, 2.6, 2.7</li>
<li>Django 1.5 (dev) supports Python 2.6, 2.7</li>
</ul>
</div></blockquote>
<p>Python 3 is supported since 0.7 release. Although 0.6 release supported Django 1.5
(which started Python 3 compliance), it was not Python 3 ready yet.</p>
</div>
<div class="section" id="unittests">
<h3>Unittests<a class="headerlink" href="#unittests" title="Permalink to this headline">¶</a></h3>
<p>Modeltranslation has a comprehensive test suite. A test runner is provided which
allows to run the tests outside of a Django project:</p>
<div class="highlight-console"><div class="highlight"><pre><span></span><span class="gp">$</span> python runtests.py
</pre></div>
</div>
<p>Non trivial changes and new features should always be accompanied by a unittest.
Pull requests which add unittests for uncovered code or rare edge cases are also
appreciated.</p>
</div>
<div class="section" id="continuous-integration">
<h3>Continuous Integration<a class="headerlink" href="#continuous-integration" title="Permalink to this headline">¶</a></h3>
<p>The project uses <a class="reference external" href="https://travis-ci.org/deschler/django-modeltranslation">Travis CI</a> for continuous integration tests. Hooks provided
by Github are active, so that each push and pull request is automatically run
against our <a class="reference external" href="https://github.com/deschler/django-modeltranslation/blob/master/.travis.yml">Travis CI config</a>, checking code against different databases,
Python and Django versions. This includes automatic tracking of test coverage
through <a class="reference external" href="https://coveralls.io/r/deschler/django-modeltranslation">Coveralls</a>.</p>
<a class="reference external image-reference" href="https://travis-ci.org/deschler/django-modeltranslation"><img alt="http://img.shields.io/travis/deschler/django-modeltranslation/master.png?style=flat" src="http://img.shields.io/travis/deschler/django-modeltranslation/master.png?style=flat" /></a>
<a class="reference external image-reference" href="https://coveralls.io/r/deschler/django-modeltranslation"><img alt="http://img.shields.io/coveralls/deschler/django-modeltranslation.png?style=flat" src="http://img.shields.io/coveralls/deschler/django-modeltranslation.png?style=flat" /></a>
</div>
</div>
<div class="section" id="contributing-documentation">
<h2>Contributing Documentation<a class="headerlink" href="#contributing-documentation" title="Permalink to this headline">¶</a></h2>
<p>Documentation is a crucial part of any open source project. We try to make
it as useful as possible for both, new and experienced developers. If you
feel that something is unclear or lacking, your help to improve it is highly
appreciated.</p>
<p>Even if you don’t feel comfortable enough to document modeltranslation’s usage
or internals, you still have a chance to contribute. None of the core
committers is a native english speaker and bad grammar or misspellings happen.
If you find any of these kind or just simple typos, nobody will feel offended
for getting an English lesson.</p>
<p>The documentation is written using <a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> and <a class="reference external" href="http://sphinx-doc.org/">Sphinx</a>. You
should try to keep a maximum line length of 80 characters. Unlike for code
contribution this isn’t a forced rule and easily exceeded by something like a
long url.</p>
</div>
<div class="section" id="using-the-issue-tracker">
<h2>Using the Issue Tracker<a class="headerlink" href="#using-the-issue-tracker" title="Permalink to this headline">¶</a></h2>
<p>When you have found a bug or want to request a new feature for modeltranslation,
please create a ticket using the project’s <a class="reference external" href="https://github.com/deschler/django-modeltranslation/issues">issue tracker</a>. Your report should
include as many details as possible, like a traceback in case you get one.</p>
<p>Please do not use the issue tracker for general questions, we run a dedicated
<a class="reference external" href="http://groups.google.com/group/django-modeltranslation">mailing list</a> for this.</p>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">How to Contribute</a><ul>
<li><a class="reference internal" href="#contributing-code">Contributing Code</a><ul>
<li><a class="reference internal" href="#coding-style">Coding Style</a></li>
<li><a class="reference internal" href="#django-and-python-versions">Django and Python Versions</a></li>
<li><a class="reference internal" href="#unittests">Unittests</a></li>
<li><a class="reference internal" href="#continuous-integration">Continuous Integration</a></li>
</ul>
</li>
<li><a class="reference internal" href="#contributing-documentation">Contributing Documentation</a></li>
<li><a class="reference internal" href="#using-the-issue-tracker">Using the Issue Tracker</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="caveats.html"
title="previous chapter">Caveats</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="related_projects.html"
title="next chapter">Related Projects</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/contribute.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</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="related_projects.html" title="Related Projects"
>next</a> |</li>
<li class="right" >
<a href="caveats.html" title="Caveats"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">django-modeltranslation 0.12.2 documentation</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2009-2018, Peter Eschler, Dirk Eschler, Jacek Tomaszewski.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.7.
</div>
</body>
</html>
|