Rev 4811: (Andrew Bennetts) Add 'Bazaar Contribution in Five Minutes' in file:///home/pqm/archives/thelove/bzr/%2Btrunk/
Canonical.com Patch Queue Manager
pqm at pqm.ubuntu.com
Thu Nov 19 02:48:39 GMT 2009
At file:///home/pqm/archives/thelove/bzr/%2Btrunk/
------------------------------------------------------------
revno: 4811 [merge]
revision-id: pqm at pqm.ubuntu.com-20091119024838-oatmgpzxox7lwx4y
parent: pqm at pqm.ubuntu.com-20091118220300-jh43xy7xqftziwql
parent: andrew.bennetts at canonical.com-20091119020312-nnygmxm3nkqy9rr7
committer: Canonical.com Patch Queue Manager <pqm at pqm.ubuntu.com>
branch nick: +trunk
timestamp: Thu 2009-11-19 02:48:38 +0000
message:
(Andrew Bennetts) Add 'Bazaar Contribution in Five Minutes'
introduction to developer docs.
added:
doc/developers/_static/bzr-doc.css bzrdoc.css-20091118014608-u0t1h53l2t81rir3-2
doc/developers/contribution-quickstart.txt contributionquicksta-20091118014608-u0t1h53l2t81rir3-1
modified:
doc/developers/_templates/layout.html layout.html-20090907074245-4b4pm5q3bjw2pt27-1
doc/developers/index.txt index.txt-20070508041241-qznziunkg0nffhiw-1
=== added file 'doc/developers/_static/bzr-doc.css'
--- a/doc/developers/_static/bzr-doc.css 1970-01-01 00:00:00 +0000
+++ b/doc/developers/_static/bzr-doc.css 2009-11-18 02:08:40 +0000
@@ -0,0 +1,4 @@
+
+ol.loweralpha {
+ list-style-type: lower-alpha;
+}
=== modified file 'doc/developers/_templates/layout.html'
--- a/doc/developers/_templates/layout.html 2009-10-30 07:51:16 +0000
+++ b/doc/developers/_templates/layout.html 2009-11-18 02:08:40 +0000
@@ -1,5 +1,10 @@
{% extends "!layout.html" %}
+{% block linktags %}
+{{ super() }}
+<link rel="stylesheet" href="_static/bzr-doc.css" type="text/css" />
+{% endblock %}
+
{% block rootrellink %}
<li><a href="http://bazaar-vcs.org/">
<img src="{{ pathto("_static/bzr icon 16.png", 1) }}" /> Home</a> | </li>
=== added file 'doc/developers/contribution-quickstart.txt'
--- a/doc/developers/contribution-quickstart.txt 1970-01-01 00:00:00 +0000
+++ b/doc/developers/contribution-quickstart.txt 2009-11-19 02:03:12 +0000
@@ -0,0 +1,59 @@
+Bazaar Contribution in Five Minutes
+===================================
+
+Contributing to Bazaar requires attention to quality. To ensure
+high-quality commits, the "Bazaar process" involves you in our
+code review and improvement activities.
+
+In brief, a contribution should include:
+
+1. A brief rationale, including expected audience and use cases,
+ for inclusion in Bazaar.
+
+2. A branch registered as a branch on Launchpad, and submitted as
+ a merge proposal.
+
+3. The branch should include:
+
+ a. implementation of the feature,
+
+ b. user documentation (if the feature is visible in the user
+ interface) and/or developer documentation (if new or
+ changed APIs are provided), and
+
+ c. tests to ensure the specification is correctly
+ implemented.
+
+For more information, see the `Bazaar Developer Guide <HACKING.html>`_.
+
+If you are not an experienced Bazaar contributor, why not ask for
+mentoring? When you submit your merge proposal on Launchpad, simply say
+"I'd like to be mentored, please" in your submission. Or ask for help
+with your contribution on the IRC channel, mailing list, or on Launchpad
+(https://answers.launchpad.net/bzr).
+
+
+Current Bazaar Mentors
+----------------------
+
+See the roster at http://bazaar-vcs.org/PatchPilot, although other
+developers may help too!
+
+
+Bazaar Mentors FAQ
+------------------
+
+1. Why is this "Bazaar process" in HACKING.txt so complicated?
+
+ Answer: If we knew *that*, we'd simplify it! We are working
+ on streamlining many aspects, but quality comes first.
+
+1. What sort of things can a mentor help with?
+
+ Anything that's getting in your way, time permitting. This includes
+ guiding you through the ``bzrlib`` API, explaining how to use our test
+ infrastructure, discussing possible designs for your bug fix or
+ feature, and so on.
+
+..
+ vim: ft=rst tw=74 ai
=== modified file 'doc/developers/index.txt'
--- a/doc/developers/index.txt 2009-09-11 07:55:48 +0000
+++ b/doc/developers/index.txt 2009-11-18 02:09:01 +0000
@@ -2,6 +2,16 @@
Bazaar Developer Document Catalog
=================================
+
+Introduction
+============
+
+.. toctree::
+ :maxdepth: 1
+
+ contribution-quickstart
+
+
Enhancing Bazaar
================
More information about the bazaar-commits
mailing list