/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

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

  • Committer: Jelmer Vernooij
  • Date: 2020-03-22 01:35:14 UTC
  • mfrom: (7490.7.6 work)
  • mto: This revision was merged to the branch mainline in revision 7499.
  • Revision ID: jelmer@jelmer.uk-20200322013514-7vw1ntwho04rcuj3
merge lp:brz/3.1.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/developers/contribution-quickstart.txt
1
 
Contributing to Bazaar
 
1
Contributing to Breezy
2
2
======================
3
3
 
4
4
Talk to us
5
5
----------
6
6
 
7
 
If you want to fix or improve something in Bazaar, we want to help you.
 
7
If you want to fix or improve something in Breezy, we want to help you.
8
8
You can ask at any time for help, on the list, on irc, or through a merge
9
9
proposal on Launchpad.
10
10
 
11
 
In particular, the rostered
12
 
`Patch Pilot <http://wiki.bazaar.canonical.com/PatchPilot>`_ 
13
 
is an experienced developer who will help you get your changes in, through
14
 
code review, advice, debugging, writing tests, or whatever it takes.
15
 
 
16
11
* `Bazaar mailing list <http://lists.ubuntu.com/mailman/listinfo/bazaar>`_
17
12
 
18
 
* IRC in channel ``#bzr`` on ``irc.ubuntu.com``
 
13
* IRC in channel ``#bzr`` on ``irc.freenode.net``
19
14
 
20
15
 
21
16
Starting
26
21
you should set it to "In Progress" and if you wish assign it to yourself.
27
22
 
28
23
You might like to start with a bug tagged `easy
29
 
<https://bugs.launchpad.net/bzr/+bugs?field.tag=easy>`_.
 
24
<https://bugs.launchpad.net/brz/+bugs?field.tag=easy>`_.
30
25
 
31
26
If you are wondering if your understanding of the bug is correct, or if the 
32
27
approach you have in mind is likely to work, feel to ask about it on the bug,
38
33
First, get a local copy of Bazaar::
39
34
 
40
35
   $ cd $HOME
41
 
   $ bzr init-repo bzr
42
 
   $ cd bzr
43
 
   $ bzr branch lp:bzr bzr.dev
 
36
   $ brz init-shared-repo brz
 
37
   $ cd brz
 
38
   $ brz branch lp:brz brz.dev
44
39
 
45
40
Now make your own branch; we recommend you include the bug number and also
46
41
a brief description::
47
42
 
48
 
   $ bzr branch bzr.dev 123456-status-speed
 
43
   $ brz branch brz.dev 123456-status-speed
49
44
 
50
45
and go ahead and commit in there.  Normally you should fix only one bug or
51
46
closely-related cluster of bugs per branch, to make reviews and merges
52
47
flow more smoothly.
53
48
 
54
 
For bugs that exist in older supported branches of bzr like 2.0 or 2.1,
55
 
you might want to fix the bug there so it can go into a bugfix release,
56
 
ie ::
57
 
 
58
 
   $ bzr branch lp:bzr/2.1 bzr.2.1
59
 
   $ bzr branch bzr.2.1 123458-2.1-status
60
 
 
61
 
You probably want this configuration in ``~/.bazaar/locations.conf``::
62
 
 
63
 
    [/home/USER/bzr]
64
 
    push_location = lp:~LAUNCHPAD_USER/bzr/
65
 
    push_location:policy = appendpath
66
 
    public_branch = http://bazaar.launchpad.net/~LAUNCHPAD_USER/bzr/
67
 
    public_branch:policy = appendpath
 
49
You probably want this configuration in ``~/.config/breezy/locations.conf``::
 
50
 
 
51
    [/home/USER/brz]
 
52
    push_location = lp:~LAUNCHPAD_USER/brz/{branchname}
 
53
    public_branch = http://bazaar.launchpad.net/~LAUNCHPAD_USER/brz/{branchname}
68
54
 
69
55
with your local and Launchpad usernames inserted.
70
56
 
76
62
After you've locally committed your changes, the configuration above
77
63
should be enough that you can push them to Launchpad with a simple ::
78
64
 
79
 
    $ bzr push
 
65
    $ brz push
80
66
 
81
67
 
82
68
Writing tests
97
83
 
98
84
To run the tests::
99
85
 
100
 
    $ ./bzr selftest
 
86
    $ ./brz selftest
101
87
 
102
88
Normally the tests will skip if some library dependencies are not present.
103
89
On Ubuntu, you can install them with this command (you must have source
104
90
repositories enabled in Software Sources)::
105
91
 
106
 
    $ sudo apt-get build-dep bzr
 
92
    $ sudo apt-get build-dep brz
107
93
 
108
94
To build the binary extensions::
109
95
 
116
102
-----------------
117
103
 
118
104
 
119
 
Then propose a merge into bzr; for bzr 2.2 and later you can use the ``bzr
120
 
lp-propose-merge`` command.  In the comment for your merge proposal please
 
105
Then propose a merge into Breezy; for Breezy 3.0 and later you can use the ``brz
 
106
propose-merge`` command.  In the comment for your merge proposal please
121
107
explain what you're trying to do and why.  For `example
122
108
<https://code.launchpad.net/~ian-clatworthy/bzr/whats-new-in-2.1/+merge/19677>`_:
123
109