Difference between revisions of "Google-CodeIn/Proposed Tasks"

From Open Food Facts wiki
Jump to navigation Jump to search
 
(22 intermediate revisions by 3 users not shown)
Line 1: Line 1:
Smaller tasks for Google Code In 2018. This is still a draft. <br><br>
+
Proposed tasks for Google Code In 2018. <br><br>
  
See [[Student projects]] for larger tasks / GSOC prep. <br>
+
== Getting started ==
See [[Student projects/School]] for School sized projects<br>
+
* Discover the project (https://world.openfoodfacts.org/discover) and how to contribute (https://world.openfoodfacts.org/contribute)
 
+
* Join Open Food Facts on Slack: register on https://slack.openfoodfacts.org
* Join Open Food Facts on Slack
+
* Star the Open Food Facts repositories of your choice (Server, API, Android and iOS apps) on Github: https://github.com/openfoodfacts
* Star the Open Food Facts repositories you like on Github
 
 
* Read the contributing guidelines https://github.com/openfoodfacts/openfoodfacts-androidapp/blob/master/CONTRIBUTING.md
 
* Read the contributing guidelines https://github.com/openfoodfacts/openfoodfacts-androidapp/blob/master/CONTRIBUTING.md
 
* Read the setup guidelines and get your project onto the local machine https://github.com/openfoodfacts/openfoodfacts-androidapp/blob/master/SETUP_GUIDELINES.md
 
* Read the setup guidelines and get your project onto the local machine https://github.com/openfoodfacts/openfoodfacts-androidapp/blob/master/SETUP_GUIDELINES.md
  
=== Documentation/Training Tasks===
+
== Tasks ==
* Help documenting the WRITE api
+
 
* Document any five classes in the Android Application
+
=== Setup ===  
* Document any ten classes in the Android Application
+
* Become a community member: create a contributor account on openfoodfacts.org and log in with that account on the wiki. Finally, join the Open Food Facts slack.
 +
Success criteria:
 +
Post a new topic on the #general channel to introduce yourself and mention your Open Food Facts username.
 +
 
 +
* Setup a development environment (for Code tasks only). Install the Open Food Facts code for one platform and compile it.
 +
Screenshot of the app running locally with your github/Open Food Facts name, and your favorite food (eg photo of the Android or iOS app running in the Device simulator + the info in a text editor next to it)
 +
 
 +
* Become a code contributor: create a github account, fork one of the Open Food Facts projects that you'd like to work later on, create a branch and push a change
 +
Create an issue linking to your branch. Karma points if your branch actually fixes something useful, and can be merged :-)
  
 
=== Outreach / Research Tasks===  
 
=== Outreach / Research Tasks===  
 +
 +
These tasks are good tasks for getting to know the Open Food Facts project and understand how it works. It is useful to complete some of them before starting other tasks like documentation, design and coding.
 +
 +
* Add 10 products to Open Food Facts
 +
** Install the Android or iOS Open Food Facts app, scan some food products, and upload pictures of the ingredients and nutrition facts table
 +
* Complete the product pages of 10 incomplete products on Open Food Facts
 +
** Create an account on https://world.openfoodfacts.org and go to the incomplete product page https://world.openfoodfacts.org/state/to-be-completed to edit some products.
 +
* Help translate the Open Food Facts app in your language
 +
* Research and give 2 new ways by which Open Food Facts can get new contributors
 
* Write a blog post about how Open Food Facts is working to help the users make a good decision about food
 
* Write a blog post about how Open Food Facts is working to help the users make a good decision about food
* Write a blog post about why you should contribute to Open Food Facts
+
* Write a blog post about why people should contribute to Open Food Facts
 
* Write a blog post about your experience with Open Food Facts
 
* Write a blog post about your experience with Open Food Facts
* Contribute 15 products to Open Food Facts
+
 
 +
==== Translation tasks ====
 +
https://translate.openfoodfacts.org
 +
 
 +
* Help translate the Open Food Facts server in your language
 
* Help translate the Open Food Facts app in your language
 
* Help translate the Open Food Facts app in your language
* Research and give 2 new ways by which Open Food Facts can get new contributors
+
* Proofread English strings for mistakes
 +
 
 +
* Success criteria:
 +
** Indicate your Crowdin profile page in an issue in [https://github.com/openfoodfacts/openfoodfacts-translations/issues openfoodfacts-translation] project.
 +
** Make sure you join the #translations channel as well as the channel for your language on Slack
  
 
===Design Tasks===
 
===Design Tasks===
* Generate at least 5 ideas on how new design elements can improve the android app
+
* Generate at least 5 ideas on how new design elements can improve the Android app
* Create a introduction slide for Category Search
+
* Create an introduction slide for Category Search
* Create a introduction slide for History
+
* Create an introduction slide for History
* Create a introduction slide for Your Contributions
+
* Create an introduction slide for Your Contributions
* Create a introduction slide for Products to be completed  
+
* Create an introduction slide for Products to be completed  
 
* Add at least 5 meaningful transitions and animations in the android application
 
* Add at least 5 meaningful transitions and animations in the android application
  
=== Java tasks ===
+
===Coding Tasks===
 +
 
 +
==== Your preferred language tasks :-) ====
 +
 
 +
* Create an app or web site that re-uses the Open Food Facts data in any way you like, with the language and technology of your choice
 +
** See https://world.openfoodfacts.org/data to get the data
 +
** If you want to build a mobile app, you can use the open source code of our iOS and Android apps to get started
 +
 
 +
==== Java tasks ====
 
https://github.com/openfoodfacts/OpenFoodFacts-androidApp/issues?page=2&q=is%3Aissue+is%3Aopen<br>
 
https://github.com/openfoodfacts/OpenFoodFacts-androidApp/issues?page=2&q=is%3Aissue+is%3Aopen<br>
TODO: Add new relevant tasks
 
 
* Fix 5 linting issues from different types
 
* Fix 5 linting issues from different types
  
=== Perl tasks ===
+
==== Perl tasks ====
 
https://github.com/openfoodfacts/openfoodfacts-server<br>
 
https://github.com/openfoodfacts/openfoodfacts-server<br>
 +
* Fix any bug of the Open Food Facts server
 +
** Pick any issue you like, or start with the issues tagged with the "5 minutes fix" label: https://github.com/openfoodfacts/openfoodfacts-server/labels/5%20minute%20fix
 
* Calculate Alcohol units in wines and beers https://github.com/openfoodfacts/openfoodfacts-server/issues/241
 
* Calculate Alcohol units in wines and beers https://github.com/openfoodfacts/openfoodfacts-server/issues/241
 
* Add updated contribution links for logged-in contributors >> https://github.com/openfoodfacts/OpenFoodFacts-androidApp/issues/159
 
* Add updated contribution links for logged-in contributors >> https://github.com/openfoodfacts/OpenFoodFacts-androidApp/issues/159
Line 43: Line 76:
 
* Create a fix for the Wiki SSO username display bug https://github.com/openfoodfacts/openfoodfacts-server/issues/476
 
* Create a fix for the Wiki SSO username display bug https://github.com/openfoodfacts/openfoodfacts-server/issues/476
  
=== PHP API tasks ===
+
==== PHP API tasks ====
 
https://github.com/openfoodfacts/openfoodfacts-php<br>
 
https://github.com/openfoodfacts/openfoodfacts-php<br>
 
* Create a WRITE call for nutrition data
 
* Create a WRITE call for nutrition data
Line 51: Line 84:
 
* Create READ calls for OCR JSONs
 
* Create READ calls for OCR JSONs
  
=== Translation tasks ===
 
https://en.wiki.openfoodfacts.org/Translations
 
 
* Help translate the Open Food Facts server in your language
 
* Help translate the Open Food Facts app in your language
 
* Proofread english strings for mistakes
 
  
=== Python API tasks ===
+
==== Python API tasks ====
 
https://github.com/openfoodfacts/openfoodfacts-python<br>
 
https://github.com/openfoodfacts/openfoodfacts-python<br>
 
* Create a WRITE call for nutrition data
 
* Create a WRITE call for nutrition data
Line 65: Line 92:
 
* Create WRITE calls for image manipulation
 
* Create WRITE calls for image manipulation
 
* Create READ calls for OCR Jsons
 
* Create READ calls for OCR Jsons
 +
 +
 +
=== Documentation/Training Tasks===
 +
* Help documenting the WRITE API for Open Food Facts
 +
* Document any five classes in the Android Application
 +
Success criteria:
 +
Merged pull Request
 +
* Document any ten classes in the Android Application
 +
Success criteria:
 +
Merged pull Request
 +
* Fix 5 coding violations
 +
Success criteria:
 +
Merged pull Request
 +
* Fix 10 coding violations
 +
Success criteria:
 +
Merged pull Request
 +
 +
 +
* See [[Student projects]] for larger tasks / Google Summer of Code <br>
 +
* See [[Student projects/School]] for School sized projects<br>
 +
  
 
[[Category:Student projects]]
 
[[Category:Student projects]]

Latest revision as of 13:35, 17 September 2018

Proposed tasks for Google Code In 2018.

Getting started

Tasks

Setup

  • Become a community member: create a contributor account on openfoodfacts.org and log in with that account on the wiki. Finally, join the Open Food Facts slack.

Success criteria: Post a new topic on the #general channel to introduce yourself and mention your Open Food Facts username.

  • Setup a development environment (for Code tasks only). Install the Open Food Facts code for one platform and compile it.

Screenshot of the app running locally with your github/Open Food Facts name, and your favorite food (eg photo of the Android or iOS app running in the Device simulator + the info in a text editor next to it)

  • Become a code contributor: create a github account, fork one of the Open Food Facts projects that you'd like to work later on, create a branch and push a change

Create an issue linking to your branch. Karma points if your branch actually fixes something useful, and can be merged :-)

Outreach / Research Tasks

These tasks are good tasks for getting to know the Open Food Facts project and understand how it works. It is useful to complete some of them before starting other tasks like documentation, design and coding.

  • Add 10 products to Open Food Facts
    • Install the Android or iOS Open Food Facts app, scan some food products, and upload pictures of the ingredients and nutrition facts table
  • Complete the product pages of 10 incomplete products on Open Food Facts
  • Help translate the Open Food Facts app in your language
  • Research and give 2 new ways by which Open Food Facts can get new contributors
  • Write a blog post about how Open Food Facts is working to help the users make a good decision about food
  • Write a blog post about why people should contribute to Open Food Facts
  • Write a blog post about your experience with Open Food Facts

Translation tasks

https://translate.openfoodfacts.org

  • Help translate the Open Food Facts server in your language
  • Help translate the Open Food Facts app in your language
  • Proofread English strings for mistakes
  • Success criteria:
    • Indicate your Crowdin profile page in an issue in openfoodfacts-translation project.
    • Make sure you join the #translations channel as well as the channel for your language on Slack

Design Tasks

  • Generate at least 5 ideas on how new design elements can improve the Android app
  • Create an introduction slide for Category Search
  • Create an introduction slide for History
  • Create an introduction slide for Your Contributions
  • Create an introduction slide for Products to be completed
  • Add at least 5 meaningful transitions and animations in the android application

Coding Tasks

Your preferred language tasks :-)

  • Create an app or web site that re-uses the Open Food Facts data in any way you like, with the language and technology of your choice

Java tasks

https://github.com/openfoodfacts/OpenFoodFacts-androidApp/issues?page=2&q=is%3Aissue+is%3Aopen

  • Fix 5 linting issues from different types

Perl tasks

https://github.com/openfoodfacts/openfoodfacts-server

PHP API tasks

https://github.com/openfoodfacts/openfoodfacts-php

  • Create a WRITE call for nutrition data
  • Create WRITE calls for product facets
  • Create WRITE calls for image addition
  • Create WRITE calls for image manipulation
  • Create READ calls for OCR JSONs


Python API tasks

https://github.com/openfoodfacts/openfoodfacts-python

  • Create a WRITE call for nutrition data
  • Create WRITE calls for product facets
  • Create WRITE calls for image addition
  • Create WRITE calls for image manipulation
  • Create READ calls for OCR Jsons


Documentation/Training Tasks

  • Help documenting the WRITE API for Open Food Facts
  • Document any five classes in the Android Application

Success criteria: Merged pull Request

  • Document any ten classes in the Android Application

Success criteria: Merged pull Request

  • Fix 5 coding violations

Success criteria: Merged pull Request

  • Fix 10 coding violations

Success criteria: Merged pull Request