launchpad help|
Size: 2742
Comment:
|
Size: 2177
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| {{{ Use this template when writing a new page of the Launchpad user guide. Important things to remember: * The table of contents should only remain if there is more than one section. * Keep the "Draft" message until the page has been reviewed and accepted. * Remove these instructions and the "Draft" message before publication. Want to know more? See the DocTeam page. }}} |
|
| Line 21: | Line 7: |
| Use the first two paragraphs to summarise all the important points about this article. | Thanks to Bazaar's distributed model, you can [[Code/FindingAndDownloading|get full access to the code of any branch]] hosted in Launchpad, with version control and history, right on your own machine. |
| Line 23: | Line 9: |
| Tell the reader if this is the information they need as soon as possible. | That flexibility means you can start work on a project without having to get special permissions to commit code. Of course, if you make changes that you want to see integrated in the project's main line, you need a way of telling the main line's owner that you want to merge your code back in. |
| Line 25: | Line 11: |
| = Instructional text = | Launchpad and Bazaar make that easy. Bazaar was made to merge: even complex merges are hassle-free. Launchpad helps look after the community process around whether a proposed merge is a good idea. |
| Line 27: | Line 13: |
| Where appropriate, use step by step instructions: | The first step is to make your merge proposal public. |
| Line 29: | Line 15: |
| '''Step 1:''' Give concise and unambiguous instructions. | = Proposing a merge = |
| Line 31: | Line 17: |
| '''Step 2:''' Try not to state the obvious, unless you're writing for a novice user. | When you've come to a stage in your development where you're ready to merge your code into another branch registered against the project - such as its main line - you can make a public merge proposal. |
| Line 33: | Line 19: |
| {i} '''Note:''' Highlight important information with a note. | To do so, visit your branch's overview page, click ''Propose for merging into another branch'', then follow the on-screen instructions. |
| Line 35: | Line 21: |
| '''Step 3:''' Use a well cropped screen shot if it will help orient the reader. Don't let the screen shot replace instructional text: not everyone can see your screen shot. Don't worry about borders or annotation for small, cropped screen shots such as this. | Now, Launchpad will notify the proposed target branch's owner of your proposal. Your proposal will also show up in the list of ''active reviews'' available from the project's code overview page, meaning your code is now subject to review by anyone and everyone who takes an interest. |
| Line 37: | Line 23: |
| {{attachment:screen-shot.png}} | = Taking part in code reviews = |
| Line 39: | Line 25: |
| {i} '''Warning:''' If you're about to tell the reader to delete or otherwise change something that would be hard to restore, warn them. | Once someone proposes a merge between branches, Launchpad opens a code review. A code review enables people - anyone with a Launchpad account - to comment and vote on the proposed merge. Let's take a look at |
| Line 42: | Line 30: |
| == Full screen shots == | You can find all of a project's active reviews by following the link on the project's code overview page. |
| Line 44: | Line 32: |
| ||<tablestyle="float:right; font-size: 0.8em; width:30%; background:#F1F1ED; margin: 0 0 1em 1em;" style="padding:0.5em;">{{attachment:proj-announce.png}}|| ||<style="text-align: center;">'''Describe the screen shot here'''|| |
|
| Line 47: | Line 33: |
| Some screen shots will be better placed to the right of your text. As they're not placed directly below the text that they support, use a border and short description. | |
| Line 49: | Line 34: |
| Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aliquam sagittis. Aliquam eros dui, scelerisque id, consequat in, accumsan vitae, pede. Suspendisse neque ligula, scelerisque ac, mattis ut, aliquam quis, odio. | |
| Line 51: | Line 35: |
| Proin nunc nisi, fringilla ac, congue ac, luctus eu, lacus. Maecenas ac purus. Cras felis metus, ultricies non, euismod ac, accumsan eleifend, leo. Quisque imperdiet tempus tellus. | |
| Line 53: | Line 36: |
| Ut euismod, diam nec adipiscing interdum, tortor orci fringilla nisi, vel blandit erat magna at nisi. Fusce hendrerit odio non metus. Mauris nisl massa, dapibus id, feugiat quis, blandit a, quam. Integer tincidunt feugiat nunc. Curabitur iaculis egestas elit. Nam imperdiet suscipit odio. | back into the project mainline - or you want to merge your code |
DRAFT: this page is a work in progress. Please seek further help or check the wiki index for a complete page on this topic.
Overview
Thanks to Bazaar's distributed model, you can get full access to the code of any branch hosted in Launchpad, with version control and history, right on your own machine.
That flexibility means you can start work on a project without having to get special permissions to commit code. Of course, if you make changes that you want to see integrated in the project's main line, you need a way of telling the main line's owner that you want to merge your code back in.
Launchpad and Bazaar make that easy. Bazaar was made to merge: even complex merges are hassle-free. Launchpad helps look after the community process around whether a proposed merge is a good idea.
The first step is to make your merge proposal public.
Proposing a merge
When you've come to a stage in your development where you're ready to merge your code into another branch registered against the project - such as its main line - you can make a public merge proposal.
To do so, visit your branch's overview page, click Propose for merging into another branch, then follow the on-screen instructions.
Now, Launchpad will notify the proposed target branch's owner of your proposal. Your proposal will also show up in the list of active reviews available from the project's code overview page, meaning your code is now subject to review by anyone and everyone who takes an interest.
Taking part in code reviews
Once someone proposes a merge between branches, Launchpad opens a code review. A code review enables people - anyone with a Launchpad account - to comment and vote on the proposed merge.
Let's take a look at
You can find all of a project's active reviews by following the link on the project's code overview page.
back into the project mainline - or you want to merge your code
