<li>Test your issue on the latest development version.</li>
<li>Create an issue in our <ahref="https://bugs.tryton.org/">issue tracker</a>.</li>
...
...
@@ -56,7 +55,6 @@
If it is a security issue, be careful to correctly set the type to security.
This way, the issue will only be visible to the security team until its release.
</div>
</p>
</section>
<sectionclass="subsection">
</div>
<divclass="subsection">
<h2id="submit-change">Submit a Change</h2>
...
...
@@ -62,4 +60,3 @@
<h2id="submit-change">Submit a Change</h2>
<p>
<ul>
<li>Follow the <ahref="#coding-guidelines">coding guidelines</a>.</li>
...
...
@@ -64,6 +61,6 @@
<ul>
<li>Follow the <ahref="#coding-guidelines">coding guidelines</a>.</li>
<li>Submit your change to our <ahref="https://codereview.tryton.org/">review tool</a> using one of the methods listed below.</li>
<li>Submit your change to our <ahref="https://codereview.tryton.org/">review tool</a> using the <ahref="https://codereview.tryton.org/static/upload.py">upload.py</a> script (see the <ahref="https://github.com/rietveld-codereview/rietveld/wiki">help page</a>).</li>
<li>Make sure the review has the repository name at the start of the review title,
and ensure the review description contains a reference to the issue (e.g.: <spanclass="text-monospace">issue1234</span>).</li>
<li>Once accepted your review will be validated with a <mark>LGTM</mark> comment from a core developer</li>
...
...
@@ -76,50 +73,9 @@
<spanclass="material-icons">warning</span>
If it is a security issue, be careful to mark the review as protected.
</div>
</p>
<p>There are two options to upload changes:</p>
<h3id="submit-change-script">Script</h3>
<p>
Download <ahref="https://codereview.tryton.org/static/upload.py"class="text-monospace">upload.py</a> and read its <ahref="https://github.com/rietveld-codereview/rietveld/wiki">help page</a>.
Always keep the <ahref="http://hg.tryton.org/tryton-env/">environment repository</a> up to date with all the <ahref="https://www.mercurial-scm.org/wiki/Subrepository">subrepos</a>:
<p>The Tryton Project strongly recommends the following guidelines.</p>
<h3id="code-style">Code Style</h3>
<h4>Python</h4>
...
...
@@ -122,8 +78,8 @@
<h2id="coding-guidelines">Coding Guidelines</h2>
<p>The Tryton Project strongly recommends the following guidelines.</p>
<h3id="code-style">Code Style</h3>
<h4>Python</h4>
<p>Code style, in general, follows <ahref="http://www.python.org/dev/peps/pep-0008/">PEP 8</a>:
<p>Code style, in general, follows <ahref="http://www.python.org/dev/peps/pep-0008/">PEP 8</a>:</p>
<ul>
<li>Use 4 spaces for indentation.</li>
<li>Avoid the usage of <spanclass="text-monospace">from M import *</span>.</li>
...
...
@@ -135,5 +91,4 @@
</ul>
</li>
</ul>
</p>
<h4>XML</h4>
...
...
@@ -139,7 +94,6 @@
<h4>XML</h4>
<p>
<ul>
<li>Use 4 spaces for indentation.</li>
<li>No 80 columns limitation.</li>
<li>Opening tag on single line or one attribute per line.</li>
</ul>
...
...
@@ -141,13 +95,11 @@
<ul>
<li>Use 4 spaces for indentation.</li>
<li>No 80 columns limitation.</li>
<li>Opening tag on single line or one attribute per line.</li>
</ul>
</p>
<h3id="best-practices">Best Practices</h4>
<p>
<h3id="best-practices">Best Practices</h3>
<ul>
<li>Use doc-strings and comments in your code.</li>
<li>Never pass keyword arguments as positional arguments when calling a method.</li>
<li>In the very beginning (right under the doc-string) of a method definition, define all pool objects that will be used (<spanclass="text-monospace">pool.get(...)</span>).</li>
</ul>
...
...
@@ -149,7 +101,6 @@
<ul>
<li>Use doc-strings and comments in your code.</li>
<li>Never pass keyword arguments as positional arguments when calling a method.</li>
<li>In the very beginning (right under the doc-string) of a method definition, define all pool objects that will be used (<spanclass="text-monospace">pool.get(...)</span>).</li>
</ul>
</p>
<h4>Naming of modules, classes, variables</h4>
...
...
@@ -155,5 +106,4 @@
<h4>Naming of modules, classes, variables</h4>
<p>
<ul>
<li>A name should be as descriptive and as short as possible.</li>
<li>Avoid unnecessary duplication of names.</li>
...
...
@@ -167,9 +117,8 @@
<li>For modules and method names use an underscore to separate the parts of name.</li>
<li>For naming classes use <ahref="http://en.wikipedia.org/wiki/CamelCase">CamelCase</a>.</li>
</ul>
</p>
</section>
<sectionclass="subsection">
</div>
<divclass="subsection">
<h2id="requirements">Requirements</h2>
<p>Your contribution must meet the following requirements:</p>
<h3>Must</h3>
...
...
@@ -173,7 +122,6 @@
<h2id="requirements">Requirements</h2>
<p>Your contribution must meet the following requirements:</p>
<h3>Must</h3>
<p>
<ul>
<li>By submitting a change, the contributor accepts the <ahref="https://developercertificate.org/">Developer Certificate of Origin</a>.</li>
<li>The contributor email must be a valid email address.</li>
...
...
@@ -182,5 +130,4 @@
<pre>Name <email></pre>
</li>
</ul>
</p>
<h3>Nice to have, but not required</h3>
...
...
@@ -186,6 +133,5 @@
<h3>Nice to have, but not required</h3>
<p>
<ul>
<li>The contributor name should be the real name of the natural person who submits the code.</li>
<li>The contributor email should be linked to only one contributor name.</li>
</ul>
...
...
@@ -188,10 +134,9 @@
<ul>
<li>The contributor name should be the real name of the natural person who submits the code.</li>
<li>The contributor email should be linked to only one contributor name.</li>
</ul>
</p>
</section>
<sectionclass="subsection">
</div>
<divclass="subsection">
<h2id="rules">Rules</h2>
<p>If the contributor has a significant amount of code, he can add himself to the <spanclass="text-monospace">COPYRIGHT</span> file.</p>
<p>
...
...
@@ -202,9 +147,24 @@
In the case of disagreement, a consensus should be reached.
As a last resort, the project leader (<ahref="https://bugs.tryton.org/user3">Cédric Krier</a>) will make the decision.
</p>
</section>
<sectionclass="subsection">
</div>
<divclass="subsection">
<h2id="publish-change">Publish a Change</h2>
<pclass="bg-info">This part is only for core developers</p>
<p>
<spanclass="material-icons">warning</span>
Always keep the <ahref="http://hg.tryton.org/tryton-env/">environment repository</a> up to date with all the <ahref="https://www.mercurial-scm.org/wiki/Subrepository">subrepos</a>: