/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-09-02 16:35:18 UTC
  • mto: (7490.40.109 work)
  • mto: This revision was merged to the branch mainline in revision 7526.
  • Revision ID: jelmer@jelmer.uk-20200902163518-sy9f4unbboljphgu
Handle duplicate directories entries for git.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/developers/contribution-quickstart.txt
 
1
Contributing to Breezy
 
2
======================
 
3
 
 
4
Talk to us
 
5
----------
 
6
 
 
7
If you want to fix or improve something in Breezy, we want to help you.
 
8
You can ask at any time for help, on the list, on irc, or through a merge
 
9
proposal on Launchpad.
 
10
 
 
11
* `Bazaar mailing list <http://lists.ubuntu.com/mailman/listinfo/bazaar>`_
 
12
 
 
13
* IRC in channel ``#bzr`` on ``irc.freenode.net``
 
14
 
 
15
 
 
16
Starting
 
17
--------
 
18
 
 
19
Before starting on a change it's a good idea to either file a bug, find a
 
20
relevant existing bug, or send a proposal to the list.  If there is a bug
 
21
you should set it to "In Progress" and if you wish assign it to yourself.
 
22
 
 
23
You might like to start with a bug tagged `easy
 
24
<https://bugs.launchpad.net/brz/+bugs?field.tag=easy>`_.
 
25
 
 
26
If you are wondering if your understanding of the bug is correct, or if the 
 
27
approach you have in mind is likely to work, feel to ask about it on the bug,
 
28
in ``#bzr`` or on the mailing list.
 
29
 
 
30
Making a branch
 
31
---------------
 
32
 
 
33
First, get a local copy of Bazaar::
 
34
 
 
35
   $ cd $HOME
 
36
   $ brz init-shared-repo brz
 
37
   $ cd brz
 
38
   $ brz branch lp:brz brz.dev
 
39
 
 
40
Now make your own branch; we recommend you include the bug number and also
 
41
a brief description::
 
42
 
 
43
   $ brz branch brz.dev 123456-status-speed
 
44
 
 
45
and go ahead and commit in there.  Normally you should fix only one bug or
 
46
closely-related cluster of bugs per branch, to make reviews and merges
 
47
flow more smoothly.
 
48
 
 
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}
 
54
 
 
55
with your local and Launchpad usernames inserted.
 
56
 
 
57
 
 
58
 
 
59
Publishing your changes
 
60
-----------------------
 
61
 
 
62
After you've locally committed your changes, the configuration above
 
63
should be enough that you can push them to Launchpad with a simple ::
 
64
 
 
65
    $ brz push
 
66
 
 
67
 
 
68
Writing tests
 
69
-------------
 
70
 
 
71
We value test coverage and generally all changes should have or update a
 
72
test.  There is a powerful test framework but it can be hard to find the
 
73
right place to put your test.  Don't hesitate to ask, or to propose a
 
74
merge that does not yet have tests.
 
75
 
 
76
Normally for command-line code you should look in
 
77
``breezy.tests.blackbox`` and for library code in ``breezy.tests``.  For
 
78
functions on an interface for which there are multiple implementations,
 
79
like `Transport`, look in ``breezy.tests.per_transport``.
 
80
 
 
81
It's a good idea to search the tests for something related to the thing
 
82
you're changing and you may find a test you can modify or adapt.
 
83
 
 
84
To run the tests::
 
85
 
 
86
    $ ./brz selftest
 
87
 
 
88
Normally the tests will skip if some library dependencies are not present.
 
89
On Ubuntu, you can install them with this command (you must have source
 
90
repositories enabled in Software Sources)::
 
91
 
 
92
    $ sudo apt-get build-dep brz
 
93
 
 
94
To build the binary extensions::
 
95
 
 
96
    $ make
 
97
 
 
98
For more information: `Testing Guide <testing.html>`_.
 
99
 
 
100
 
 
101
Proposing a merge
 
102
-----------------
 
103
 
 
104
 
 
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
 
107
explain what you're trying to do and why.  For `example
 
108
<https://code.launchpad.net/~ian-clatworthy/bzr/whats-new-in-2.1/+merge/19677>`_:
 
109
 
 
110
  As discussed on the mailing list, this patch adds a What's New document
 
111
  summarising the changes since 2.0.
 
112
 
 
113
If you make additional changes to your branch you don't need to resubmit;
 
114
they'll automatically show up in the merge proposal.
 
115
 
 
116
* `Launchpad Code Review Help <http://help.launchpad.net/Code/Review>`_.
 
117
 
 
118
 
 
119
..
 
120
   vim: ft=rst tw=74 ai