ubuntu-touch-coreapps-reviewers team mailing list archive

[Bartosz Kosiorek <gang65@xxxxxxxxxxxxxx>]

Review: Needs Fixing

It is very nice improvement.
I have added some small inline comments.

Thanks!

Diff comments:

> 
> === added file 'README-Autopilot.md'
> --- README-Autopilot.md	1970-01-01 00:00:00 +0000
> +++ README-Autopilot.md	2015-12-22 06:35:00 +0000
> @@ -0,0 +1,79 @@
> +Running Autopilot tests
> +=======================
> +
> +The calculator 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 calculator 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 calculator app, here are some useful links to help you:
> +
> +- [Ubuntu - Quality](http://developer.ubuntu.com/start/quality)
> +- [Ubuntu - Autopilot](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 ubuntu-ui-toolkit-autopilo

typo in package name

> +
> +Running tests on the desktop
> +============================
> +
> +Using terminal:
> +
> +*  Branch the Calculator app code, for example,
> +
> +    $ bzr branch lp:ubuntu-calculator-app
> +    
> +*  Navigate to the tests/autopilot directory.
> +
> +    $ cd ubuntu-calculator-app/tests/autopilot
> +
> +*  run all tests.
> +
> +    $ autopilot3 run -vv ubuntu_calculator_app
> +
> +* to list all tests:
> +
> +    $ autopilot3 list ubuntu_calculator_app
> +
> + * To run only one test (for instance: ubuntu_calculator_app.tests.test_main.MainTestCase.test_divide_by_zero
> +)

please move the closing bracket up, or move example to the next line

> +
> +    $ autopilot3 run -vv ubuntu_calculator_app.tests.test_main.MainTestCase.test_divide_by_zero
> +
> +* Debugging tests using autopilot vis
> +
> +    $ autopilot3 launch -i Qt qmlscene app/ubuntu-calculator-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:
> +====================================
> +
> +Using autopkg:
> +
> +*  Branch the CAlculator app code, for example,

CAlculator -> Calculator

> +
> +    $ bzr branch lp:ubuntu-calculator-app
> +
> +*  Navigate to the source directory.
> +
> +    $ cd ubuntu-calculator-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>
> +
> 
> === added file 'README-Developers.md'
> --- README-Developers.md	1970-01-01 00:00:00 +0000
> +++ README-Developers.md	2015-12-22 06:35:00 +0000
> @@ -0,0 +1,73 @@
> +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 ubuntu-calculator-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
> +
> +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 nad unit 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,
> +
> +   
> +

Please leave only one blank line

> +    $ bzr commit -m "Implemented bug fix" --fixes lp:bug-number
> +    $ bzr push lp:~launchpadid/ubuntu-calculator-app/branch-name
> +
> +Running Tests
> +=============
> +
> +Please check README-Autopilot.md and README-Unittest.md on how to run the tests.

Please use `README-Autopilot.md` and `README-Unittest.md` or similar to make these files visible.

> +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, 

It seems that `inside' has different Apostrophe

> +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.
> +
> +     run app/ubuntu-calculator-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


-- 
https://code.launchpad.net/~emailgirishrawat/ubuntu-calculator-app/READMEs/+merge/281174
Your team Ubuntu Calculator Developers is subscribed to branch lp:ubuntu-calculator-app.