Latest revision as of 19:47, 11 February 2014

[edit] Getting Started in Fixing Bugs

Prerequisites

• Mer SDK installed
• User accounts
  • Community OBS same account as bugzilla below, https://wiki.merproject.org/wiki/Nemo/OBS#Getting_started_with_the_build_system
  • Nemo Bugzilla account (same account works on both mer and nemo bugzilla, register here: https://bugs.merproject.org/createaccount.cgi)
• For running on device: Nemo Mobile device
• Optionally
  • For N900/N950 devices Qt SDK 1.1.4 with Harmattan target installed may help testing the fix

[edit] Take a bug

1. Go to https://bugs.nemomobile.org
2. Choose a bug: [1]
3. Change the assignee to yourself
4. Change the bug status to assigned

[edit] Create a patch

Ideally, we would fix the upstream package and would release a new version of the package. However, many times we want fix quicker than this allows and thus end up temporarily patching the package. This gives a brief instructions on how.

Once you know which package needs to be fixed

1. Find where the upstream git repository is
2. Clone the sources

   git clone <url>

3. Check out the release tag that matches the version in Nemo
4. Create local branch for you fix
5. Fix the sources.
   • In fixing your package the QtSDK may help you if you work on N900 or N950. See hello world -tutorial for details
   • Second option is to use local builds using osc. (TODO tutorial)
   • Third option is let OBS build the package. (In practice in this point ignoring if the fix works and executing the remaining steps and steps in the next section)
6. Once the fix works commit your fix to your local branch
7. create patch with

   git format-patch

[edit] Submit the patch upstream

Nemo contains software from a variety of sources, so there isn't always a clear guideline for how to do this, but generally speaking:

• For anything we maintain (generally speaking, anything on https://github.com/nemomobile), please submit a pull request on github. The right people should get a mail notification automatically, but feel free to ping us in #nemomobile too.
• For software from Maemo (or MeeGo), or other sources where there may not be an active upstream, please ask (in #nemomobile) to get a repository created in the nemomobile project on github.
• For anything else, please follow upstream proceedures. If you can't find them, please ping in #nemomobile and we'll try help you out.

If you're unsure, or need help, please just ask.

[edit] Building package with the patch in OBS

Please note that you don't need to patch packages that we maintain (see github). Instead, we should be making releases of those packages. Generally, the maintainer(s) of the packages will take care of this in a reasonable amount of time after your patch is merged, but please ping someone on #nemomobile if this process takes too long. (TODO: write a page on release guidelines)

1. Log into community OBS
2. Search for the package needing the fix
3. Branch the package
4. Go to your computers command line
5. Check out your branched package with

   osc -A https://api.merproject.org/ co <your_branched_project>/<package-name>

6. Change into dir that was checked out above
7. Copy the patch to working dir
8. Add the patch to package's source files with

   osc add <patch>

9. Add the patch in .yaml file in the patches-section
10. Run specify to update .spec file
11. Update .changes file. See details of changelog format here
12. Check in your changes with

    osc ci -m "fixes NEMO#xx"

    where xx is bug number
13. Go back to community OBS Web UI. Check that your package builds.
14. Once OBS has succesfully built a package for your architecture, install it on your device to check that it works.

[edit] Submit your fixed package to Nemo

1. Go to community OBS Web UI
2. Enable publish for all architectures (under your branched project -> repositories)
3. In case you have not done this before it would be good to say in irc channel #nemomobile that you are planning to submit bug fix
4. Go to overview page of the package
5. Submit
6. Mark the bug in bugzilla as fixed and add link to submit request to comments of the bug
7. Be prepared to do (typically minor) fixes based on automated feedback by build infrastructure or by review of maintainer (sage). Create a new submit request with the fix, if you will try to reopen the old declined one, then the same old non-fixed revision will be used.
8. Once the fix has been accepted maintainer (Sage) will mark the bug as released in bugzilla

[edit] More information

• There is an example with images of a bug's life in Vesku's blog