← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/developers/contribution-quickstart.txt

  • Committer: Robert Collins
  • Date: 2006-07-20 13:00:31 UTC
  • mto: (1852.9.1 Tree.compare().)
  • mto: This revision was merged to the branch mainline in revision 1890.
  • Revision ID: robertc@robertcollins.net-20060720130031-d26103a427ea10f3
Start tree implementation tests.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/developers/contribution-quickstart.txt
1
 
Bazaar Contribution in Five Minutes
2
 
===================================
3
 
 
4
 
Contributing to Bazaar requires attention to quality.  To ensure
5
 
high-quality commits, the "Bazaar process" involves you in our
6
 
code review and improvement activities.
7
 
 
8
 
In brief, a contribution should include:
9
 
 
10
 
1.  A brief rationale, including expected audience and use cases,
11
 
    for inclusion in Bazaar.
12
 
 
13
 
2.  A branch registered as a branch on Launchpad, and submitted as
14
 
    a merge proposal.
15
 
 
16
 
3.  The branch should include:
17
 
 
18
 
    a.  implementation of the feature,
19
 
 
20
 
    b.  user documentation (if the feature is visible in the user
21
 
        interface) and/or developer documentation (if new or
22
 
        changed APIs are provided), and
23
 
 
24
 
    c.  tests to ensure the specification is correctly
25
 
        implemented.
26
 
 
27
 
For more information, see the `Bazaar Developer Guide <HACKING.html>`_.
28
 
 
29
 
If you are not an experienced Bazaar contributor, why not ask for
30
 
mentoring?  When you submit your merge proposal on Launchpad, simply say
31
 
"I'd like to be mentored, please" in your submission.  Or ask for help
32
 
with your contribution on the IRC channel, mailing list, or on Launchpad
33
 
(https://answers.launchpad.net/bzr).
34
 
 
35
 
 
36
 
Current Bazaar Mentors
37
 
----------------------
38
 
 
39
 
See the roster at http://bazaar-vcs.org/PatchPilot, although other
40
 
developers may help too!
41
 
 
42
 
 
43
 
Bazaar Mentors FAQ
44
 
------------------
45
 
 
46
 
1.  Why is this "Bazaar process" in HACKING.txt so complicated?
47
 
 
48
 
    Answer: If we knew *that*, we'd simplify it!  We are working
49
 
    on streamlining many aspects, but quality comes first.
50
 
 
51
 
1.  What sort of things can a mentor help with?
52
 
 
53
 
    Anything that's getting in your way, time permitting.  This includes
54
 
    guiding you through the ``bzrlib`` API, explaining how to use our test
55
 
    infrastructure, discussing possible designs for your bug fix or
56
 
    feature, and so on.
57
 
 
58
 
..
59
 
   vim: ft=rst tw=74 ai