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
1=== modified file 'README'
2--- README 2015-11-09 10:37:47 +0000
3+++ README 2015-12-16 20:34:26 +0000
4@@ -1,20 +1,36 @@
5-Weather app for Ubuntu devices
6-
7-To contribute:
8- https://wiki.ubuntu.com/Touch/CoreApps/Weather
9- https://wiki.ubuntu.com/Touch/CoreApps/DevelopmentGuide
10-
11-Note: The OpenWeatherMap service now requires an API key where previously
12- it did not. FOSS developers can register for a free API key
13- which needs to be put into app/data/keys.js for the app to
14- function correctly. Do not commit branches with the key in place
15- as a centrally managed key is injected at build time.
16-
17- See http://openweathermap.org/faq#error401 for details and
18- http://openweathermap.org/appid to obtain a personal key.
19-
20-The following essential packages are required to develop this app:
21-- ubuntu-sdk (see http://developer.ubuntu.com/start)
22-- intltool - run the `sudo apt-get install intltool` command for installation
23-
24-See the debian/control file for an up-to-date list of dependencies
25+ReadMe - Ubuntu Weather App
26+===========================
27+Ubuntu Weather App is the official weather app for Ubuntu Touch. We follow an open
28+source model where the code is available to anyone to branch and hack on. The
29+ubuntu weather app follows a test driven development (TDD) where tests are
30+written in parallel to feature implementation to help spot regressions easier.
31+
32+API
33+===
34+The OpenWeatherMap service requires an API key.
35+Visit http://openweathermap.org/appid to obtain a personal key.
36+Visit http://openweathermap.org/faq#error401 for more details.
37+Place the keys in app/data/keys.js
38+
39+Do not commit branches with the key in place as a centrally managed key is injected at build time.
40+
41+Dependencies
42+============
43+DEPENDENCIES ARE NEEDED TO BE INSTALLED TO BUILD AND RUN THE APP.
44+
45+A complete list of dependencies for the project can be found in ubuntu-weather-app/debian/control
46+
47+The following essential packages are also required to develop this app:
48+* ubuntu-sdk - http://developer.ubuntu.com/start
49+* intltool - run the `sudo apt-get install intltool` command for installation
50+
51+Useful Links
52+============
53+Here are some useful links with regards to the Weather App development.
54+
55+* Home Page - https://developer.ubuntu.com/en/community/core-apps/weather/
56+* Weather App Wiki - https://wiki.ubuntu.com/Touch/CoreApps/Weather
57+
58+* Designs - https://docs.google.com/presentation/d/1tXcyMBvJAYvwFvUAmTTYzmBP2NFQgbG_Gy8e2gv91kU/edit#slide=id.p
59+
60+* Project page - https://launchpad.net/ubuntu-weather-app
61
62=== modified file 'README.autopilot'
63--- README.autopilot 2015-07-23 00:36:06 +0000
64+++ README.autopilot 2015-12-16 20:34:26 +0000
65@@ -1,4 +1,5 @@
66-# Running Autopilot tests
67+Running Autopilot tests
68+=======================
69
70 The 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.
71
72@@ -11,12 +12,14 @@
73
74 - https://developer.ubuntu.com/en/start/platform/guides/running-autopilot-tests/
75
76-## Prerequisites
77+Prerequisites
78+=============
79
80 Install the following autopilot packages required to run the tests,
81 $ sudo apt-get install python3-autopilot libautopilot-qt ubuntu-ui-toolkit-autopilot python3-autopilot-vis
82
83-## Running tests on the desktop
84+Running tests on the desktop
85+============================
86
87 Using terminal:
88
89@@ -39,8 +42,13 @@
90 $ autopilot3 launch -i Qt qmlscene app/ubuntu-weather-app.qml
91 $ autopilot3 vis
92
93-
94-## Running tests on device or emulator:
95+Running tests using Ubuntu SDK
96+==============================
97+
98+Refer this tutorial to run tests on Ubuntu SDK: https://developer.ubuntu.com/en/start/platform/guides/running-autopilot-tests/
99+
100+Running tests on device or emulator:
101+====================================
102
103 Using autopkg:
104
105
106=== added file 'README.developers'
107--- README.developers 1970-01-01 00:00:00 +0000
108+++ README.developers 2015-12-16 20:34:26 +0000
109@@ -0,0 +1,78 @@
110+Building and running on Vivid Desktop (15.04)
111+=============================================
112+
113+Building and running the Ubuntu Weather App is quite simple. You will require
114+Ubuntu 15.04 and higher to run on the desktop.
115+
116+ $ bzr branch lp:ubuntu-weather-app branch-name
117+ $ cd branch-name
118+ $ mkdir builddir && cd builddir
119+ $ cmake .. && make -j3
120+ $ qmlscene ../app/ubuntu-weather-app.qml
121+
122+Submitting a patch upstream
123+===========================
124+
125+If you want to submit a bug fix you can do so by branching the code as shown
126+above, implementing the fixes and running to see if it fixed the issue. We also
127+request that you run the Autopilottests to check if anything
128+regressed due to the bug fix.
129+
130+If the tests fail, you will have to fix them before your bug fix can be
131+approved and merged into trunk. If the tests pass then commit and push your
132+code by,
133+
134+ $ bzr commit -m "Implemented bug fix" --fixes lp:bug-number
135+ $ bzr push lp:~launchpadid/ubuntu-weather-app/branch-name
136+
137+Running Tests
138+=============
139+
140+Please check README.autopilot on how to run the tests.
141+They are quite explanatory and will help you get started.
142+
143+Code Style
144+==========
145+
146+We are trying to use a common code style throughout the code base to maintain
147+uniformity and improve code clarity. Listed below are the code styles guides
148+that will be followed based on the language used.
149+
150+* QML - http://qt-project.org/doc/qt-5/qml-codingconventions.html
151+* JS, C++ - https://google-styleguide.googlecode.com/svn/trunk/cppguide.xml
152+* Python - Code should follow PEP8 and Flake regulations
153+
154+Note: In the QML code convention, ignore the Javascript code section guidelines.
155+So the sections that should be taken into account in the QML conventions are QML
156+Object Declarations, Grouped Properties and Lists.
157+
158+Debugging
159+=========
160+
161+GDB allows one to see what is going on `inside' another program while it executes,
162+or what another program was doing at the moment it crashed. It is a pretty niffty tool which allows you
163+to get the crash log that can help a developer pin point the cause of the crash.
164+Before reproducing crash it is good to create symbols table for gdb, by using command:
165+
166+ $ cd branch-name
167+ $ mkdir builddir && cd builddir
168+ $ cmake -DCMAKE_BUILD_TYPE=Debug .. && make -j3
169+
170+To run GDB:
171+
172+ $ gdb qmlscene
173+
174+At this point, you are inside the gdb prompt. Run your application as you normally would.
175+
176+ run ../app/ubuntu-weather-app.qml
177+
178+Your app is now running and monitored by GDB. Reproduce the steps in your app to make it crash. Once it does crash,
179+
180+ bt
181+
182+That's about it. To quit GDB, type quit to return back to the normal terminal console.
183+
184+ quit
185+
186+
187+
188
189=== added file 'README.mergeproposal'
190--- README.mergeproposal 1970-01-01 00:00:00 +0000
191+++ README.mergeproposal 2015-12-16 20:34:26 +0000
192@@ -0,0 +1,33 @@
193+Prerequisites to approving a Merge Proposal (MP)
194+================================================
195+
196+Over time, it has been found that insufficient testing by reviewers sometimes
197+leads to weather app trunk not buildable in Qtcreator due to manifest errors, or
198+translation pot file not updated. As such, please follow the checklist below
199+before top-approving a MP.
200+
201+Checklist
202+=========
203+
204+* Does the MP add/remove user visible strings? If Yes, has the pot file been
205+ updated?
206+
207+* Did you remove the API key? (refer README)
208+
209+* Does the MP change the UI? If Yes, has it been approved by design?
210+
211+* Did you perform an exploratory manual test run of your code change and any
212+ related functionality?
213+
214+* If the MP fixes a bug or implements a feature, are there accompanying unit
215+ and autopilot tests?
216+
217+* Is the weather app trunk buildable and runnable using Qtcreator?
218+
219+* Was the debian changelog updated?
220+
221+* Was the copyright years updated if necessary?
222+
223+The above checklist is more of a guideline to help weather app trunk stay buildable,
224+stable and up to date.
225+
226
227=== modified file 'README.translations'
228--- README.translations 2015-05-14 23:34:48 +0000
229+++ README.translations 2015-12-16 20:34:26 +0000
230@@ -1,4 +1,5 @@
231-# Updating translations
232+Updating translations
233+=====================
234
235 Translations for the Weather app happen in [Launchpad Translations][] and
236 are automatically committed daily on the trunk branch in the po/ folder.
237@@ -18,7 +19,8 @@
238
239 And that's it, once the branch lands Launchpad should take care of all the rest!
240
241-# Behind the scenes
242+Behind the scenes
243+=================
244
245 Behind the scenes, whenever the po/*.pot file (also known as translations template)
246 is committed to trunk Launchpad reads it and updates the translatable strings

Subscribers

People subscribed via source and target branches

to all changes: