Merge lp:~emailgirishrawat/music-app/READMEs into lp:music-app

[Girish]

Expanded and updated READMEs.

Expanded and updated READMEs.

[lp:~emailgirishrawat/music-app/READMEs]

957. By Girish on 2015-12-18

Fixed typos and improved READMEs

[Victor Thompson (vthompson)]

Hi Girish! Thanks again. I have a few inline comments for you.

review: Needs Fixing

[lp:~emailgirishrawat/music-app/READMEs]

958. By Girish on 2015-12-18

Edited READMEs

[Girish (emailgirishrawat)]

vthompson : Fixed.

[Victor Thompson (vthompson)]

LGTM! Thanks! Don't forget to add a commit message.

review: Approve

[Andrew Hayzen (ahayzen)]

LGTM, just one comment

1) Could you update the design doc link, as you did with weather?

review: Needs Fixing

[lp:~emailgirishrawat/music-app/READMEs]

959. By Girish on 2015-12-22

Updated design section in README.md

[Andrew Hayzen (ahayzen)]

LGTM, thanks for the changes :-)

review: Approve

[Jenkins Bot (ubuntu-core-apps-jenkins-bot)]

review: Approve (continuous-integration)

=== added file 'README-Autopilot.md'
--- README-Autopilot.md	1970-01-01 00:00:00 +0000
+++ README-Autopilot.md	2015-12-22 01:26:28 +0000
@@ -0,0 +1,99 @@
+Running Autopilot tests
+=======================
+
+The Music app follows a test driven development where autopilot tests are run before every merge into trunk. If you are submitting your bugfix/patch to the Music app, please follow the following steps below to ensure that all tests pass before proposing a merge request.
+
+If you are looking for more info about Autopilot or writing AP tests for the music app, here are some useful links to help you:
+
+- [Ubuntu - Quality](http://developer.ubuntu.com/start/quality)
+- [Autopilot - Python](https://developer.ubuntu.com/api/autopilot/python/1.5.0/)
+
+For help and options on running tests, see:
+
+- [Autopilot tests](https://developer.ubuntu.com/en/start/platform/guides/running-autopilot-tests/)
+
+Prerequisites
+=============
+
+Install the following autopilot packages required to run the tests,
+
+    $ sudo apt-get install python3-autopilot libautopilot-qt ubuntu-ui-toolkit-autopilot python3-autopilot-vis
+
+Running tests on the desktop
+============================
+
+Using terminal:
+
+*  Branch the Music app code, for example,
+
+    $ bzr branch lp:music-app
+    
+*  Navigate to the tests/autopilot directory.
+
+    $ cd music-app/tests/autopilot
+
+*  run all tests.
+
+    $ autopilot3 run -vv music_app
+
+* to list all tests:
+
+    $ autopilot3 list music_app
+
+ To run only one test (for instance:  music_app.tests.test_music.TestMainWindow.test_swipe_to_delete_song)
+
+    $ autopilot3 run -vv music_app.tests.test_music.TestMainWindow.test_swipe_to_delete_song
+
+* Debugging tests using autopilot vis
+
+    $ autopilot3 launch -i Qt qmlscene app/music-app.qml
+
+    $ autopilot3 vis
+
+Running tests using Ubuntu SDK
+==============================
+
+Refer this [tutorial](https://developer.ubuntu.com/en/start/platform/guides/running-autopilot-tests/) to run tests on Ubuntu SDK: 
+
+Running tests on device or emulator:
+====================================
+
+## Set up the system
+
+Prior to running tests on the device, follow the steps to find music in the system.
+
+    $ mv /home/phablet/Music /home/phablet/.Music
+    $ restart mediascanner-2.0
+
+Using autopkg:
+
+*  Branch the Music app code, for example,
+
+    $ bzr branch lp:music-app
+
+*  Navigate to the source directory.
+
+    $ cd music-app
+
+*  Build a click package
+    
+    $ click-buddy .
+
+*  Run the tests on device (assumes only one click package in the directory)
+
+    $ adt-run . *.click --- ssh -s adb -- -p <PASSWORD>
+
+*  Resolving mediascanner2 schema issues when tests fail
+
+Occasionally the schema for the mediascanner2 (ms2) service is incremented and updates to the mocked ms2 database are required. The following steps should be taken to update the database and sql file when this happens.
+
+1. Dump a new schema file for the database for debugging:
+   $ sqlite3 ~/.cache/mediascanner-2.0/mediastore.db .sch > tests/autopilot/music_app/content/mediascanner-2.0/mediastore.sch
+
+2. Edit the SQL file to use the new schemaVersion number:
+   $ vi tests/autopilot/music_app/content/mediascanner-2.0/mediastore.sql
+
+3. If the tests still do not pass, execute the following bzr command to debug what has changed in the schema and update the SQL file to insert the values for each column in the 'media' table accordingly:
+   $ bzr diff tests/autopilot/music_app/content/mediascanner-2.0/mediastore.sch
+   $ vi tests/autopilot/music_app/content/mediascanner-2.0/mediastore.sql
+

=== added file 'README-Developers.md'
--- README-Developers.md	1970-01-01 00:00:00 +0000
+++ README-Developers.md	2015-12-22 01:26:28 +0000
@@ -0,0 +1,82 @@
+Building and running on Desktop
+===============================
+
+Building and running the Ubuntu Music App is quite simple. You will require
+Ubuntu 15.04 and higher to run on the desktop.
+
+   
+
+    $ bzr branch lp:music-app branch-name
+    $ cd branch-name
+    $ qmlscene app/music-app.qml
+
+Submitting a patch upstream
+===========================
+
+If you want to submit a bug fix you can do so by branching the code as shown
+above, implementing the fixes and running to see if it fixed the issue. We also
+request that you run the Autopilot tests to check if anything
+regressed due to the bug fix.
+
+If the tests fail, you will have to fix them before your bug fix can be
+approved and merged into trunk. If the tests pass then commit and push your
+code by,
+
+   
+
+    $ bzr commit -m "Implemented bug fix" --fixes lp:bug-number
+    $ bzr push lp:~launchpadid/music-app/branch-name
+
+Running Tests
+=============
+
+Please check README-Autopilot.md on how to run the tests.
+They are quite explanatory and will help you get started.
+
+Code Style
+==========
+
+We are trying to use a common code style throughout the code base to maintain
+uniformity and improve code clarity. Listed below are the code styles guides
+that will be followed based on the language used.
+
+* [QML](http://qt-project.org/doc/qt-5/qml-codingconventions.html) 
+* [JS, C++](https://google-styleguide.googlecode.com/svn/trunk/cppguide.xml) 
+* Python     - Code should follow PEP8 and Flake regulations
+
+Note: In the QML code convention, ignore the Javascript code section guidelines.
+So the sections that should be taken into account in the QML conventions are QML 
+Object Declarations, Grouped Properties and Lists.
+
+Debugging
+=========
+ 
+GDB allows one to see what is going on `inside' another program while it executes, 
+or what another program was doing at the moment it crashed. It is a pretty niffty tool which allows you 
+to get the crash log that can help a developer pin point the cause of the crash.
+Before reproducing crash it is good to create symbols table for gdb, by using command:
+
+   
+
+    $ cd branch-name	
+
+To run GDB:
+
+   
+
+    $ gdb qmlscene
+
+At this point, you are inside the gdb prompt. Run your application as you normally would.
+
+     $ app/music-app.qml
+
+Your app is now running and monitored by GDB. Reproduce the steps in your app to make it crash. Once it does crash,
+
+     bt
+
+That's about it. To quit GDB, type quit to return back to the normal terminal console.
+
+     quit
+
+
+

=== added file 'README-Mergeproposal.md'
--- README-Mergeproposal.md	1970-01-01 00:00:00 +0000
+++ README-Mergeproposal.md	2015-12-22 01:26:28 +0000
@@ -0,0 +1,28 @@
+Prerequisites to approving a Merge Proposal (MP)
+================================================
+
+Over time, it has been found that insufficient testing by reviewers sometimes leads to music app trunk not buildable in Qtcreator due to manifest errors, or translation pot file not updated. As such, please follow the checklist below before top-approving a MP.
+
+Checklist
+=========
+
+*   Does the MP add/remove user visible strings? If Yes, has the pot file been
+    updated?
+
+*   Does the MP change the UI? If Yes, has it been approved by design?
+
+*   Did you perform an exploratory manual test run of your code change and any
+    related functionality?
+
+*   If the MP fixes a bug or implements a feature, are there accompanying unit
+    and autopilot tests?
+
+*   Is the music app trunk buildable and runnable using Qtcreator?
+
+*   Was the debian changelog updated?
+
+*   Was the copyright years updated if necessary?
+
+The above checklist is more of a guideline to help music app trunk stay buildable,
+stable and up to date.
+

=== added file 'README-Translations.md'
--- README-Translations.md	1970-01-01 00:00:00 +0000
+++ README-Translations.md	2015-12-22 01:26:28 +0000
@@ -0,0 +1,35 @@
+Updating translations
+=====================
+
+Translations for the Music app happen in [Launchpad Translations](https://translations.launchpad.net/music-app) and are automatically committed daily on the trunk branch in the po/ folder.
+
+They are then built and installed as part of the package build, so that
+developers don't really need to worry about them.
+
+However, there is one task that needs to be taken care of: exposing new
+translatable messages to translators. So whenever you add new translatable
+messages in the code, make sure to follow these steps:
+
+ 1. Run click-buddy retaining the build directory:
+    $ click-buddy --dir . --no-clean
+ 2. Copy the .pot file from the <build dir> mentioned in the output to your
+    original source:
+    $ cp <build dir>/po/*.pot po/
+ 3. Commit the generated .pot file:
+    $ bzr commit -m "Updated translation template"
+ 4. Push the branch and send a merge proposal as usual
+
+And that's it, once the branch lands Launchpad should take care of all the rest!
+
+Behind the scenes
+=================
+
+Behind the scenes, whenever the po/*.pot file (also known as translations template) is committed to trunk Launchpad reads it and updates the translatable strings exposed in the web UI. This will enable translators to work on the new strings.
+The translations template contains all translatable strings that have been extracted from the source code files.
+
+Launchpad will then store translations in its database and will commit them daily in the form of textual po/*.po files to trunk. The PO files are also usually referred to as the translations files. You'll find a translation file for each language the app has got at least a translated message available for.
+
+Translations for core apps follow the standard [gettext format](https://www.gnu.org/software/gettext/).
+
+ [Launchpad Translations](https://translations.launchpad.net/music-app)
+ [Gettext format](https://www.gnu.org/software/gettext/)

=== removed file 'README.autopilot'
--- README.autopilot	2015-11-03 02:43:10 +0000
+++ README.autopilot	1970-01-01 00:00:00 +0000
@@ -1,76 +0,0 @@
-# Running Autopilot tests
-
-Music App follows a test driven development where autopilot tests are run before every merge into trunk. If you are submitting your bugfix/patch to the music app, please follow the following steps below to ensure that all tests pass before proposing a merge request.
-
-If you are looking for more info about Autopilot or writing AP tests for the music app, here are some useful links to help you:
-
-- http://developer.ubuntu.com/start/quality
-- https://developer.ubuntu.com/api/autopilot/python/1.5.0/
-
-For help and options on running tests, see:
-
-- https://developer.ubuntu.com/en/start/platform/guides/running-autopilot-tests/
-
-## Prerequisites
-
-Install the following autopilot packages required to run the tests,
-$ sudo apt-get install python3-autopilot libautopilot-qt ubuntu-ui-toolkit-autopilot python3-autopilot-vis
-
-## Running tests on the desktop
-
-Using terminal:
-
-*  Branch the music app code, for example,
-    $ bzr branch lp:music-app
-    
-*  Navigate to the tests/autopilot directory.
-    $ cd music-app/tests/autopilot
-
-*  run all tests.
-    $ autopilot3 run -vv music_app
-
-    to list all tests:
-    $ autopilot3 list music_app
-
-    To run only one test (for instance: music_app.tests.test_music.TestMainWindow.test_swipe_to_delete_song)
-    $ autopilot3 run -vv music_app.tests.test_music.TestMainWindow.test_swipe_to_delete_song
-
-    Debugging tests using autopilot vis
-    $ autopilot3 launch -i Qt qmlscene app/music-app.qml
-    $ autopilot3 vis
-
-## Running tests on device or emulator:
-
-NOTE: Prior to running the tests on the device, you will need to do the following if there is music on the system:
-
-    $ mv /home/phablet/Music /home/phablet/.Music
-    $ restart mediascanner-2.0
-
-Using autopkg:
-
-*  Branch the Music app code, for example,
-    $ bzr branch lp:music-app
-
-*  Navigate to the source directory.
-    $ cd music-app
-
-*  Build a click package
-    $ click-buddy .
-
-*  Run the tests on device (assumes only one click package in the directory)
-    $ adt-run . *.click --- ssh -s adb -- -p <PASSWORD>
-
-# Resolving mediascanner2 schema issues when tests fail
-
-Occasionally the schema for the mediascanner2 (ms2) service is incremented and updates to the mocked ms2 database are required. The following steps should be taken to update the database and sql file when this happens.
-
-1. Dump a new schema file for the database for debugging:
-   $ sqlite3 ~/.cache/mediascanner-2.0/mediastore.db .sch > tests/autopilot/music_app/content/mediascanner-2.0/mediastore.sch
-
-2. Edit the SQL file to use the new schemaVersion number:
-   $ vi tests/autopilot/music_app/content/mediascanner-2.0/mediastore.sql
-
-3. If the tests still do not pass, execute the following bzr command to debug what has changed in the schema and update the SQL file to insert the values for each column in the 'media' table accordingly:
-   $ bzr diff tests/autopilot/music_app/content/mediascanner-2.0/mediastore.sch
-   $ vi tests/autopilot/music_app/content/mediascanner-2.0/mediastore.sql
-

=== added file 'README.md'
--- README.md	1970-01-01 00:00:00 +0000
+++ README.md	2015-12-22 01:26:28 +0000
@@ -0,0 +1,25 @@
+ReadMe - Ubuntu Music App
+===========================
+Ubuntu Music App is the official music app for Ubuntu Touch. We follow an open
+source model where the code is available to anyone to branch and hack on. The
+ubuntu music app follows a test driven development (TDD) where tests are
+written in parallel to feature implementation to help spot regressions easier.
+
+Dependencies
+============
+**DEPENDENCIES ARE NEEDED TO BE INSTALLED TO BUILD AND RUN THE APP**.
+
+A complete list of dependencies for the project can be found in music-app/debian/control
+
+The following essential packages are also required to develop this app:
+* [ubuntu-sdk](http://developer.ubuntu.com/start)
+* intltool   - run  `sudo apt-get install intltool` 
+
+Useful Links
+============
+Here are some useful links with regards to the Music App development.
+
+* [Home Page](https://developer.ubuntu.com/en/community/core-apps/music/)
+* [Music App Wiki](https://wiki.ubuntu.com/Touch/CoreApps/Music)
+* [Designs](https://developer.ubuntu.com/en/community/core-apps/music/#design)
+* [Project page](https://launchpad.net/music-app) 

=== removed file 'README.translations'
--- README.translations	2014-04-27 18:25:48 +0000
+++ README.translations	1970-01-01 00:00:00 +0000
@@ -1,40 +0,0 @@
-# Updating translations
-
-Translations for the Music app happen in [Launchpad Translations][] and
-are automatically committed daily on the trunk branch in the po/ folder.
-
-They are then built and installed as part of the package build, so that
-developers don't really need to worry about them.
-
-However, there is one task that needs to be taken care of: exposing new
-translatable messages to translators. So whenever you add new translatable
-messages in the code, make sure to follow these steps:
-
- 1. Run click-buddy retaining the build directory:
-    `click-buddy --dir . --no-clean`
- 2. Copy the .pot file from the <build dir> mentioned in the output to your
-    original source:
-    `cp <build dir>/po/*.pot po/`
- 3. Commit the generated .pot file:
-    `bzr commit -m"Updated translation template"`
- 4. Push the branch and send a merge proposal as usual
-
-And that's it, once the branch lands Launchpad should take care of all the rest!
-
-# Behind the scenes
-
-Behind the scenes, whenever the po/*.pot file (also known as translations template)
-is committed to trunk Launchpad reads it and updates the translatable strings
-exposed in the web UI. This will enable translators to work on the new strings.
-The translations template contains all translatable strings that have been
-extracted from the source code files.
-
-Launchpad will then store translations in its database and will commit them daily
-in the form of textual po/*.po files to trunk. The PO files are also usually
-referred to as the translations files. You'll find a translation file for each
-language the app has got at least a translated message available for.
-
-Translations for core apps follow the standard [gettext format].
-
- [Launchpad Translations]: https://translations.launchpad.net/music-app
- [gettext format]: https://www.gnu.org/software/gettext/

=== modified file 'debian/changelog'
--- debian/changelog	2015-12-03 19:53:17 +0000
+++ debian/changelog	2015-12-22 01:26:28 +0000
@@ -6,6 +6,9 @@
   [ Ken VanDine ]
   * Install the content-hub json file in the correct place for peer registry
 
+  [ Girish Rawat ]
+  * Expanded and updated READMEs
+
  -- Andrew Hayzen <[e-mail]>  Thu, 03 Dec 2015 14:11:35 +0000
 
 music-app (2.2ubuntu2) vivid; urgency=medium