Submitting

Differences between revisions 1 and 3 (spanning 2 versions)
Revision 1 as of 2008-08-31 13:17:14
Size: 1803
Editor: 79-72-87-179
Comment: creating from DocumentationTeam/Repository
Revision 3 as of 2009-12-13 20:50:16
Size: 2347
Editor: 79-72-41-101
Comment: expand to include the option of pushing to Launchpad
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
<<Include(DocumentationTeam/MenuBar)>> <<Include(DocumentationTeam/SystemDocumentation/MenuBar)>>
Line 3: Line 3:
= Making a patch = = Submitting your Changes =
Line 9: Line 9:
Preparing a patch is easy. You can make a patch for a single file or a group of files that have been modified. The first step is to save your changes locally.
Line 12: Line 12:
 1. Issue the {{{bzr update}}} command. This updates your working copy with changes from the repository. Check for conflicts and resolve them.
 1. Issue the {{{bzr status}}} command. This shows the status of files. Ensure that all conflicts are resolved.
 1. Issue the command {{{bzr diff > diffname.txt}}}
 (!) If you wish to include your own name and a narrative for your change, you should create a ''bundle'' rather than a patch. To do this, issue these commands instead of the command at step 4 above:{{{
$ bzr commit -m "your narrative here"
 1. Issue the {{{bzr update}}} command. This updates your working copy with changes from the repository. Check for conflicts and resolve them. It is a good idea to ensure that your branch is up to date before editing any files.
 1. Issue the {{{bzr status}}} command. This shows the status of files which you have edited. Ensure that all conflicts are resolved.
 1. Commit your changes locally by running:{{{
$ bzr commit}}}
  bzr will prompt you to give a narrative to describe your change. Please be as detailed as possible. If your change addresses a Launchpad bug, include the bug number in the format "LP: #123456".

The next step is to publish your changes for the Documentation Team to review.

 1. If your change is a small one, the simplest way to publish it is to create a "bundle" and email it to the Documentation Team or attach it to a bug report:{{{
Line 18: Line 22:

This creates the file {{{diffname.txt}}}, which contains the differences between the working copy and repository revisions of the modified files.

You should send the patch/bundle to the team [[DocumentationTeam/Contact|mailing list]] or attach it to a relevant bug report. If you have a mentor, copy them into the email and ask them to review it.
  This creates the file {{{diffname.txt}}}, which contains the differences between the working copy and repository revisions of the modified files.
 1. You should send the patch/bundle to the team [[DocumentationTeam/Contact|mailing list]] or attach it to a relevant bug report. If you have a mentor, copy them into the email and ask them to review it.
 1. Alternatively, if your changes are larger, you can publish them as a branch on Launchpad:{{{
$ bzr push lp:~yourusername/ubuntu-docs/branchname}}}
  "branchname" should be a short word which describes the branch. Usually your username will suffice.

Submitting your Changes

Once you have made a change to a document and checked your work, the next step is to submit your change to the DocumentationTeam.

Note: It is generally a better idea to make several small changes and send them individually than it is to make one big change.

The first step is to save your changes locally.

  1. Go to the top level of the branch you are working on.
  2. Issue the bzr update command. This updates your working copy with changes from the repository. Check for conflicts and resolve them. It is a good idea to ensure that your branch is up to date before editing any files.

  3. Issue the bzr status command. This shows the status of files which you have edited. Ensure that all conflicts are resolved.

  4. Commit your changes locally by running:

    $ bzr commit
    • bzr will prompt you to give a narrative to describe your change. Please be as detailed as possible. If your change addresses a Launchpad bug, include the bug number in the format "LP: #123456".

The next step is to publish your changes for the Documentation Team to review.

  1. If your change is a small one, the simplest way to publish it is to create a "bundle" and email it to the Documentation Team or attach it to a bug report:

    $ bzr bundle > diffname.txt
    • This creates the file diffname.txt, which contains the differences between the working copy and repository revisions of the modified files.

  2. You should send the patch/bundle to the team mailing list or attach it to a relevant bug report. If you have a mentor, copy them into the email and ask them to review it.

  3. Alternatively, if your changes are larger, you can publish them as a branch on Launchpad:

    $ bzr push lp:~yourusername/ubuntu-docs/branchname
    • "branchname" should be a short word which describes the branch. Usually your username will suffice.

For more information about working with bzr, see the bzr website.

After you get used to DocBook, bzr and the DocumentationTeam, you are very likely to be offered an account so that you can write to the repository as well.

DocumentationTeam/SystemDocumentation/Submitting (last edited 2014-07-02 21:59:17 by knome)