Merge lp:~emailgirishrawat/ubuntu-weather-app/READMEs into lp:ubuntu-weather-app

Proposed by Girish on 2015-12-16
Status: Rejected
Rejected by: Andrew Hayzen on 2015-12-18
Proposed branch: lp:~emailgirishrawat/ubuntu-weather-app/READMEs
Merge into: lp:ubuntu-weather-app
Diff against target: 246 lines (+164/-27)
5 files modified
README (+36/-20)
README.autopilot (+13/-5)
README.developers (+78/-0)
README.mergeproposal (+33/-0)
README.translations (+4/-2)
To merge this branch: bzr merge lp:~emailgirishrawat/ubuntu-weather-app/READMEs
Reviewer Review Type Date Requested Status
Andrew Hayzen 2015-12-16 Disapprove on 2015-12-18
Review via email: mp+280770@code.launchpad.net

Description of the change

Updated README, README.autopilot, README.translations.
Added README.developers, README.mergeproposal

To post a comment you must log in.
Andrew Hayzen (ahayzen) wrote :

Awesome! As discussed, can we make this into markdown format so that this could then be automatically parsed on sites such as developer.ubuntu.com and ensures a consistent format for use across all core apps.

I think most of it already is markdown? But I'll just let you confirm that it is, some of the sections like the bash commands I wonder if there is a markdown format for that?

review: Needs Information
Andrew Hayzen (ahayzen) wrote :

I believe this has been superseded by [0], therefore I am rejecting this merge proposal.

0 - https://code.launchpad.net/~emailgirishrawat/ubuntu-weather-app/markdown-readmes/+merge/280787

review: Disapprove

Unmerged revisions

189. By Girish on 2015-12-16

Minor changes in README.developers

188. By Girish on 2015-12-16

Expanded and updated READMEs

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
=== modified file 'README'
--- README 2015-11-09 10:37:47 +0000
+++ README 2015-12-16 20:34:26 +0000
@@ -1,20 +1,36 @@
1Weather app for Ubuntu devices1ReadMe - Ubuntu Weather App
22===========================
3To contribute:3Ubuntu Weather App is the official weather app for Ubuntu Touch. We follow an open
4 https://wiki.ubuntu.com/Touch/CoreApps/Weather4source model where the code is available to anyone to branch and hack on. The
5 https://wiki.ubuntu.com/Touch/CoreApps/DevelopmentGuide5ubuntu weather app follows a test driven development (TDD) where tests are
66written in parallel to feature implementation to help spot regressions easier.
7Note: The OpenWeatherMap service now requires an API key where previously7
8 it did not. FOSS developers can register for a free API key8API
9 which needs to be put into app/data/keys.js for the app to 9===
10 function correctly. Do not commit branches with the key in place10The OpenWeatherMap service requires an API key.
11 as a centrally managed key is injected at build time.11Visit http://openweathermap.org/appid to obtain a personal key.
1212Visit http://openweathermap.org/faq#error401 for more details.
13 See http://openweathermap.org/faq#error401 for details and13Place the keys in app/data/keys.js
14 http://openweathermap.org/appid to obtain a personal key.14
1515Do not commit branches with the key in place as a centrally managed key is injected at build time.
16The following essential packages are required to develop this app:16
17- ubuntu-sdk (see http://developer.ubuntu.com/start)17Dependencies
18- intltool - run the `sudo apt-get install intltool` command for installation18============
1919DEPENDENCIES ARE NEEDED TO BE INSTALLED TO BUILD AND RUN THE APP.
20See the debian/control file for an up-to-date list of dependencies20
21A complete list of dependencies for the project can be found in ubuntu-weather-app/debian/control
22
23The following essential packages are also required to develop this app:
24* ubuntu-sdk - http://developer.ubuntu.com/start
25* intltool - run the `sudo apt-get install intltool` command for installation
26
27Useful Links
28============
29Here are some useful links with regards to the Weather App development.
30
31* Home Page - https://developer.ubuntu.com/en/community/core-apps/weather/
32* Weather App Wiki - https://wiki.ubuntu.com/Touch/CoreApps/Weather
33
34* Designs - https://docs.google.com/presentation/d/1tXcyMBvJAYvwFvUAmTTYzmBP2NFQgbG_Gy8e2gv91kU/edit#slide=id.p
35
36* Project page - https://launchpad.net/ubuntu-weather-app
2137
=== modified file 'README.autopilot'
--- README.autopilot 2015-07-23 00:36:06 +0000
+++ README.autopilot 2015-12-16 20:34:26 +0000
@@ -1,4 +1,5 @@
1# Running Autopilot tests1Running Autopilot tests
2=======================
23
3The Weather 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 Weather app, please follow the following steps below to ensure that all tests pass before proposing a merge request.4The Weather 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 Weather app, please follow the following steps below to ensure that all tests pass before proposing a merge request.
45
@@ -11,12 +12,14 @@
1112
12- https://developer.ubuntu.com/en/start/platform/guides/running-autopilot-tests/13- https://developer.ubuntu.com/en/start/platform/guides/running-autopilot-tests/
1314
14## Prerequisites15Prerequisites
16=============
1517
16Install the following autopilot packages required to run the tests,18Install the following autopilot packages required to run the tests,
17$ sudo apt-get install python3-autopilot libautopilot-qt ubuntu-ui-toolkit-autopilot python3-autopilot-vis19$ sudo apt-get install python3-autopilot libautopilot-qt ubuntu-ui-toolkit-autopilot python3-autopilot-vis
1820
19## Running tests on the desktop21Running tests on the desktop
22============================
2023
21Using terminal:24Using terminal:
2225
@@ -39,8 +42,13 @@
39 $ autopilot3 launch -i Qt qmlscene app/ubuntu-weather-app.qml42 $ autopilot3 launch -i Qt qmlscene app/ubuntu-weather-app.qml
40 $ autopilot3 vis43 $ autopilot3 vis
4144
4245Running tests using Ubuntu SDK
43## Running tests on device or emulator:46==============================
47
48Refer this tutorial to run tests on Ubuntu SDK: https://developer.ubuntu.com/en/start/platform/guides/running-autopilot-tests/
49
50Running tests on device or emulator:
51====================================
4452
45Using autopkg:53Using autopkg:
4654
4755
=== added file 'README.developers'
--- README.developers 1970-01-01 00:00:00 +0000
+++ README.developers 2015-12-16 20:34:26 +0000
@@ -0,0 +1,78 @@
1Building and running on Vivid Desktop (15.04)
2=============================================
3
4Building and running the Ubuntu Weather App is quite simple. You will require
5Ubuntu 15.04 and higher to run on the desktop.
6
7 $ bzr branch lp:ubuntu-weather-app branch-name
8 $ cd branch-name
9 $ mkdir builddir && cd builddir
10 $ cmake .. && make -j3
11 $ qmlscene ../app/ubuntu-weather-app.qml
12
13Submitting a patch upstream
14===========================
15
16If you want to submit a bug fix you can do so by branching the code as shown
17above, implementing the fixes and running to see if it fixed the issue. We also
18request that you run the Autopilottests to check if anything
19regressed due to the bug fix.
20
21If the tests fail, you will have to fix them before your bug fix can be
22approved and merged into trunk. If the tests pass then commit and push your
23code by,
24
25 $ bzr commit -m "Implemented bug fix" --fixes lp:bug-number
26 $ bzr push lp:~launchpadid/ubuntu-weather-app/branch-name
27
28Running Tests
29=============
30
31Please check README.autopilot on how to run the tests.
32They are quite explanatory and will help you get started.
33
34Code Style
35==========
36
37We are trying to use a common code style throughout the code base to maintain
38uniformity and improve code clarity. Listed below are the code styles guides
39that will be followed based on the language used.
40
41* QML - http://qt-project.org/doc/qt-5/qml-codingconventions.html
42* JS, C++ - https://google-styleguide.googlecode.com/svn/trunk/cppguide.xml
43* Python - Code should follow PEP8 and Flake regulations
44
45Note: In the QML code convention, ignore the Javascript code section guidelines.
46So the sections that should be taken into account in the QML conventions are QML
47Object Declarations, Grouped Properties and Lists.
48
49Debugging
50=========
51
52GDB allows one to see what is going on `inside' another program while it executes,
53or what another program was doing at the moment it crashed. It is a pretty niffty tool which allows you
54to get the crash log that can help a developer pin point the cause of the crash.
55Before reproducing crash it is good to create symbols table for gdb, by using command:
56
57 $ cd branch-name
58 $ mkdir builddir && cd builddir
59 $ cmake -DCMAKE_BUILD_TYPE=Debug .. && make -j3
60
61To run GDB:
62
63 $ gdb qmlscene
64
65At this point, you are inside the gdb prompt. Run your application as you normally would.
66
67 run ../app/ubuntu-weather-app.qml
68
69Your app is now running and monitored by GDB. Reproduce the steps in your app to make it crash. Once it does crash,
70
71 bt
72
73That's about it. To quit GDB, type quit to return back to the normal terminal console.
74
75 quit
76
77
78
079
=== added file 'README.mergeproposal'
--- README.mergeproposal 1970-01-01 00:00:00 +0000
+++ README.mergeproposal 2015-12-16 20:34:26 +0000
@@ -0,0 +1,33 @@
1Prerequisites to approving a Merge Proposal (MP)
2================================================
3
4Over time, it has been found that insufficient testing by reviewers sometimes
5leads to weather app trunk not buildable in Qtcreator due to manifest errors, or
6translation pot file not updated. As such, please follow the checklist below
7before top-approving a MP.
8
9Checklist
10=========
11
12* Does the MP add/remove user visible strings? If Yes, has the pot file been
13 updated?
14
15* Did you remove the API key? (refer README)
16
17* Does the MP change the UI? If Yes, has it been approved by design?
18
19* Did you perform an exploratory manual test run of your code change and any
20 related functionality?
21
22* If the MP fixes a bug or implements a feature, are there accompanying unit
23 and autopilot tests?
24
25* Is the weather app trunk buildable and runnable using Qtcreator?
26
27* Was the debian changelog updated?
28
29* Was the copyright years updated if necessary?
30
31The above checklist is more of a guideline to help weather app trunk stay buildable,
32stable and up to date.
33
034
=== modified file 'README.translations'
--- README.translations 2015-05-14 23:34:48 +0000
+++ README.translations 2015-12-16 20:34:26 +0000
@@ -1,4 +1,5 @@
1# Updating translations1Updating translations
2=====================
23
3Translations for the Weather app happen in [Launchpad Translations][] and4Translations for the Weather app happen in [Launchpad Translations][] and
4are automatically committed daily on the trunk branch in the po/ folder.5are automatically committed daily on the trunk branch in the po/ folder.
@@ -18,7 +19,8 @@
1819
19And that's it, once the branch lands Launchpad should take care of all the rest!20And that's it, once the branch lands Launchpad should take care of all the rest!
2021
21# Behind the scenes22Behind the scenes
23=================
2224
23Behind the scenes, whenever the po/*.pot file (also known as translations template)25Behind the scenes, whenever the po/*.pot file (also known as translations template)
24is committed to trunk Launchpad reads it and updates the translatable strings26is committed to trunk Launchpad reads it and updates the translatable strings

Subscribers

People subscribed via source and target branches

to all changes: