6,323
edits
SeasonOfDocs: Difference between revisions
no edit summary
(2022 project) |
No edit summary |
||
| (7 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
== Welcome! == | |||
Open Food Facts is a non-profit open source and open data project with a massive impact on the food and health of millions of people across the world, and we need your help to make this impact even bigger in many more parts of the world! | |||
=== '''Open Food Facts is a participant organization for the Google Season of Docs 2022: see [[GSOD2022 API documentation]]''' === | |||
== Getting started == | |||
If you would like to work on the Open Food Facts documentation project during the Google Season of Docs, make sure to join the Open Food Facts community on Slack, introduce yourself there and get familiar with the project. | |||
A good way to do that is to open your fridge or cupboard to find a food item to scan with our Android or iOS application. Open Food Facts works like Wikipedia. The food product may already be in the database with its data completed. If it’s present, you will get valuable information about its nutritional quality (Nutri-Score) or its level of food processing (NOVA). If it’s not present yet, please take some pictures and add it! | |||
'''Submit your statement of interest''' via email to contact -AT- openfoodfacts.org put GSOD in the subject, '''by the 9th of may, 2022''': present yourself, your skills and experiences, and your personal approach to the project. | |||
== 2022 project == | |||
=== Have a complete OpenAPI compliant documentation for the Open Food Facts API === | === Have a complete OpenAPI compliant documentation for the Open Food Facts API === | ||
| Line 43: | Line 57: | ||
Estimated time on the project: 200 hours (25 days on 5 month). | Estimated time on the project: 200 hours (25 days on 5 month). | ||
=== Getting started now tasklist === | |||
The following things can help you select a project and prepare your idea: | |||
* Join our chat room | |||
* Introduce yourself in the #api-documentation channel | |||
* Join the channels related to the countries you're interested in | |||
* It is important to first familiarize with the API documentation and project. | |||
* Try one of our "good first issues" on GitHub | |||
* Please, go through the available documentation and direct your questions to the Slack chat. | |||
* As you learn, it is also a good idea to propose updates to the documentation. | |||
* If you have not worked before with Git Branching, we encourage you to visit this web: <nowiki>https://learngitbranching.js.org/</nowiki> | |||
* Fill our upcoming introduction survey (it is NOT an application form) | |||
== 2022 project management == | |||
See [https://developers.google.com/season-of-docs/docs/timeline GSOD timeline]. | |||
[[Category:Project]] | |||
[[Category:Documentation]] | |||