164
edits
Julianharty (talk | contribs) (Added some initial goals. These are open to change. Others are also welcome.) |
|||
(3 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
= Mini Hackathon for Kiwix Android = | = Mini Hackathon for Kiwix Android = | ||
A mini-hackathon | A mini-hackathon was hosted by Julian Harty. Dates: 14th and 15th December 2017. | ||
== Goals == | == Goals == | ||
To address various problems related to the Kiwix Android apps, improve the automated testing and the diagnostic logging. We will also explore whether to add a global exception handler to the app and improve the error reporting to users. | To address various problems related to the Kiwix Android apps, improve the automated testing and the diagnostic logging. We will also explore whether to add a global exception handler to the app and improve the error reporting to users. | ||
* Effective Logging: to improve testing and troubleshooting. Revise logging in the app to report relevant data that may help with diagnostics, particularly for recent problems including crashes, access to zim files, etc. | * Effective Logging: to improve testing and troubleshooting. Revise logging in the app to report relevant data that may help with diagnostics, particularly for recent problems including crashes, access to zim files, etc. | ||
* Better automated testing: to increase our confidence in the product and make the automated builds and testing more trustworthy and useful. This will include creating additional Mock Objects: Implement the mocks needed for tests that use network operations e.g. download tests. | * Better automated testing: to increase our confidence in the product and make the automated builds and testing more trustworthy and useful. This will include creating additional Mock Objects: Implement the mocks needed for tests that use network operations e.g. download tests. Also, be great to improve the testing of key functionality including searching and results. | ||
* Global Error Handling: Review the initial spike that includes a global error handler and triage whether to use it, do something similar instead, or not bother. | * Global Error Handling: Review the initial spike that includes a global error handler and triage whether to use it, do something similar instead, or not bother. | ||
* Better error detection and error handling in the app: so fewer problems / errors cause the app to crash in use. | * Better error detection and error handling in the app: so fewer problems / errors cause the app to crash in use. | ||
Line 13: | Line 13: | ||
Based on our review of the hackathon in Lyon we would prefer to complete smaller concrete tasks rather than open long-running exploratory code branches (many remaining open and untouched since Lyon). Therefore we'd like to commit changes and merge them on a daily basis where practical, and all changes within a week of the hackathon completing. | Based on our review of the hackathon in Lyon we would prefer to complete smaller concrete tasks rather than open long-running exploratory code branches (many remaining open and untouched since Lyon). Therefore we'd like to commit changes and merge them on a daily basis where practical, and all changes within a week of the hackathon completing. | ||
== Participants == | == Participants == | ||
* Elad | * Elad (visiting from Israel) | ||
* Isaac | * Isaac (visiting from London/Warrington) | ||
* Joe | * Joe (visiting from a couple of miles away) | ||
* Julian | * Julian | ||
== Results == | |||
We were able to make progress and improvements in various aspects of the kiwix-android project. This included creating a proof-of-concept global error handler and reporting feature. We're awaiting feedback from other members of the Kiwix team. | |||
We also created the new https://github.com/kiwix/testfiles repository, raised bugs and fixed things in several related repos, and documented how to create a local download server for testing. | |||
We also integrated the new JNI video changes into the Android app. | |||
== Costs == | == Costs == | ||
Minimal for the Kiwix foundation. | Minimal for the Kiwix foundation. | ||
== Venue == | == Venue == | ||
Julian's home. | |||
[[Category:hackathon]] |
edits