Changes

Jump to navigation Jump to search
1,587 bytes added ,  07:45, 12 May 2020
Remove legacy projects and add robotoff
Line 1: Line 1: −
We have a lot of development work to do: on the Open Food Facts backend (Perl and MongoDB), API (JSON), web site (HTML5, JS, Foundation), iOS / Android / Windows Phone / FirefoxOS apps (currently developed in HTML and JS with Apache Cordova / Phonegap), to build new cool reuses etc. Our code is on GitHub.
+
The Open Food Facts software is developed collaboratively by hackers from all around the world.
 +
 
 +
We have a lot of development work to do:
 +
* Open Food Facts backend (Perl and MongoDB);
 +
* Web site (HTML5, JS, Foundation);
 +
* iOS native (Swift);
 +
* Android native (Java);
 +
* Robotoff, our machine learning service
 +
* Build new cool reuses etc...
 +
 
 +
All our code is on GitHub : [https://github.com/openfoodfacts/ https://github.com/openfoodfacts/]
    
== Needs ==
 
== Needs ==
   −
* We firstly need resources that work on issues. There is many issues, categorized by topics, see:
+
There is many issues, categorized by topics, see:
** [https://github.com/openfoodfacts/openfoodfacts-server/issues Website and server issues]
+
* [https://github.com/openfoodfacts/openfoodfacts-server/issues Website, backend and API issues]
** [https://github.com/openfoodfacts/openfoodfacts-androidapp Android app issues]
+
** For beginners see [https://github.com/openfoodfacts/openfoodfacts-server/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22 First Good Issue] category
** [https://github.com/openfoodfacts/ All the repositories]
+
** For those who love i18n see [https://github.com/openfoodfacts/openfoodfacts-server/issues?q=is%3Aopen+is%3Aissue+label%3Ai18n translations] category
 +
** See [https://github.com/openfoodfacts/openfoodfacts-server/labels all the categories]
 +
* [https://github.com/openfoodfacts/openfoodfacts-androidapp/issues Android app issues]
 +
* [https://github.com/openfoodfacts/openfoodfacts-ios/issues iOS app issues]
 +
* [https://github.com/openfoodfacts/openfoodfacts-ai/issues Open Food Facts AI issues]
 +
* [https://github.com/openfoodfacts/ All the repositories]
    
== Principles ==
 
== Principles ==
   −
* You have to discuss the topics or issues or functionalities you want to work on. Slack is the best choice for it.
+
Our goal is to follow and keep few and simple guidelines.
* You should open an issue on Github to explain the problem you want to solve or the functionnality you want to work on.
+
 
* You fork the project and create one branche per issue or functionality you want to work on. When you're ready to propose something, you send a "pull request".
+
# '''discuss the topics or issues or functionalities you want to work on'''. The [http://slack.openfoodfacts.org/ slack workspace] is the best choice for it.
Coding style is defined in the .editorconfig file, see https://github.com/openfoodfacts/openfoodfacts-server/blob/master/.editorconfig
+
# if not already done, '''open an issue''' on Github to explain the problem you want to solve or the functionality you want to work on.
 +
# if you want to work on an existing issue, '''tell everyone in the issue's Github comments'''.
 +
# fork the project and '''create one branch per issue or functionality you want to work on'''.
 +
## It's cool to name a branch: ''issue/[issue_number]-[name]''; ex.: ''issue/1630-name-of-the-issue''
 +
## When you're ready to propose something, send a "pull request"; be patient, sometimes it takes time to the core team to review pull request.
 +
# '''coding style''' is defined in the .editorconfig file, see [https://github.com/openfoodfacts/openfoodfacts-server/blob/master/.editorconfig https://github.com/openfoodfacts/openfoodfacts-server/blob/master/.editorconfig]; many editors support EditorConfig, check yours: https://editorconfig.org
 +
 
 +
== Inspirations ==
 +
 
 +
* https://www.mediawiki.org/wiki/How_to_contribute
 +
* Inspirations from https://www.mediawiki.org/wiki/How_to_become_a_MediaWiki_hacker
 +
* Wikimedia makes a difference between:
 +
** policies, what people MUST do: https://www.mediawiki.org/wiki/Development_policy
 +
** guidelines, what people SHOULD do: https://www.mediawiki.org/wiki/Development_guideline

Navigation menu