Commit 88680353 authored by Florian Fuchs's avatar Florian Fuchs

added section on workflow to the dev documentation

parent 49082729
......@@ -37,6 +37,31 @@ the file structure probably looks familiar. These are the basics:
# class for views based on a single mailing list
Development Workflow
====================
The source code is hosted on Launchpad_, which also means that we are using
Bazaar for version control.
.. _Launchpad: https://launchpad.net
Changes are usually not made directly in the project's trunk branch, but in
feature-related personal branches, which get reviewed and then merged into
the trunk.
The ideal workflow would be like this:
1. File a bug to suggest a new feature or report a bug (or just pick one of
the existing bugs).
2. Create a new branch with your code changes.
3. Make a "merge proposal" to get your code reviewed and merged.
Launchpad has a nice tour_ which describes all this in detail.
.. _tour: https://launchpad.net/+tour/index
Writing View Code
=================
......
......@@ -81,6 +81,22 @@ views/
# class for views based on a single mailing list</pre>
</div>
</div>
<div class="section" id="development-workflow">
<h2>Development Workflow<a class="headerlink" href="#development-workflow" title="Permalink to this headline"></a></h2>
<p>The source code is hosted on <a class="reference external" href="https://launchpad.net">Launchpad</a>, which also means that we are using
Bazaar for version control.</p>
<p>Changes are usually not made directly in the project&#8217;s trunk branch, but in
feature-related personal branches, which get reviewed and then merged into
the trunk.</p>
<p>The ideal workflow would be like this:</p>
<ol class="arabic simple">
<li>File a bug to suggest a new feature or report a bug (or just pick one of
the existing bugs).</li>
<li>Create a new branch with your code changes.</li>
<li>Make a &#8220;merge proposal&#8221; to get your code reviewed and merged.</li>
</ol>
<p>Launchpad has a nice <a class="reference external" href="https://launchpad.net/+tour/index">tour</a> which describes all this in detail.</p>
</div>
<div class="section" id="writing-view-code">
<h2>Writing View Code<a class="headerlink" href="#writing-view-code" title="Permalink to this headline"></a></h2>
<p>When the work on Postorius was started, the standard way to write view code in
......@@ -257,6 +273,7 @@ like objects retreived from mailman.client, like:</p>
<ul>
<li><a class="reference internal" href="#">Development</a><ul>
<li><a class="reference internal" href="#directory-layout">Directory layout</a></li>
<li><a class="reference internal" href="#development-workflow">Development Workflow</a></li>
<li><a class="reference internal" href="#writing-view-code">Writing View Code</a></li>
<li><a class="reference internal" href="#authentication-authorization">Authentication/Authorization</a></li>
<li><a class="reference internal" href="#accessing-the-mailman-api">Accessing the Mailman API</a></li>
......
......@@ -37,6 +37,31 @@ the file structure probably looks familiar. These are the basics:
# class for views based on a single mailing list
Development Workflow
====================
The source code is hosted on Launchpad_, which also means that we are using
Bazaar for version control.
.. _Launchpad: https://launchpad.net
Changes are usually not made directly in the project's trunk branch, but in
feature-related personal branches, which get reviewed and then merged into
the trunk.
The ideal workflow would be like this:
1. File a bug to suggest a new feature or report a bug (or just pick one of
the existing bugs).
2. Create a new branch with your code changes.
3. Make a "merge proposal" to get your code reviewed and merged.
Launchpad has a nice tour_ which describes all this in detail.
.. _tour: https://launchpad.net/+tour/index
Writing View Code
=================
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment