Tech Team: Difference between revisions

From Open Food Facts wiki
No edit summary
mNo edit summary
Line 1: Line 1:
The Open Food Facts software is developed collaboratively by hackers from all around the world.
The Open Food Facts software is developed collaboratively by hackers from all around the world.  
 
All developement happens on '''GitHub''': https://github.com/openfoodfacts/


We have a lot of development work to do:
We have a lot of development work to do:
* Open Food Facts backend (Perl and MongoDB);
 
=== Project we're working on: ===
* Server backend (Perl and MongoDB);
* Web site (HTML5, JS, Foundation, within the backend code as templates);
* Web site (HTML5, JS, Foundation, within the backend code as templates);
* iOS native (Swift);
* iOS native (Swift);
* Android native (Java);
* Android native (Kotlin);
* Robotoff, our machine learning service (Python)
* Robotoff, our machine learning service (Python);
* Hunger Games, our annotation engine (Javascript)
* Hunger Games, our annotation web app (VueJS);
* Our various SDKs (Python, Ruby, Dart, PHP…)
* Our various SDKs (Python, Ruby, Dart, PHP…);
* Build new cool reuses etc...
* ''... your idea ...''


=== Topics you can work on ===
=== Topics you can work on ===
Line 21: Line 25:
*[https://github.com/openfoodfacts/openfoodfacts-hungergames/issues/234 Hunger Games (VueJS)]
*[https://github.com/openfoodfacts/openfoodfacts-hungergames/issues/234 Hunger Games (VueJS)]


All our code is on GitHub : [https://github.com/openfoodfacts/ https://github.com/openfoodfacts/]
''Software development page on the website: https://world.openfoodfacts.org/development''
 
Software development page on the website: https://world.openfoodfacts.org/development


== Needs ==
== Needs ==
Line 35: Line 37:
* [https://github.com/openfoodfacts/openfoodfacts-ios/issues iOS 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/openfoodfacts-ai/issues Open Food Facts AI issues]
* [https://github.com/openfoodfacts/ All the repositories]


== Principles ==
== Principles ==
Line 41: Line 42:
Our goal is to follow and keep few and simple guidelines.
Our goal is to follow and keep few and simple guidelines.


# '''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.
# '''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.
# 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 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'''.
# 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'''.
# 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''
#* It's cool to name a branch: ''<code>issue/[issue_number]-[name]</code>''; ex.: ''<code>issue/1630-name-of-the-issue</code>''
## 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.
#* When you're ready to propose something, send a '''Pull Request'''. Be patient, sometimes it takes time to the core team to review PRs.
# '''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
# The '''coding style''' is defined in the <code>[https://github.com/openfoodfacts/openfoodfacts-server/blob/master/.editorconfig .editorconfig]</code> file. Many editors support EditorConfig, check yours: https://editorconfig.org


== Inspirations ==
== Inspirations ==

Revision as of 14:46, 5 September 2021

The Open Food Facts software is developed collaboratively by hackers from all around the world.

All developement happens on GitHub: https://github.com/openfoodfacts/

We have a lot of development work to do:

Project we're working on:

  • Server backend (Perl and MongoDB);
  • Web site (HTML5, JS, Foundation, within the backend code as templates);
  • iOS native (Swift);
  • Android native (Kotlin);
  • Robotoff, our machine learning service (Python);
  • Hunger Games, our annotation web app (VueJS);
  • Our various SDKs (Python, Ruby, Dart, PHP…);
  • ... your idea ...

Topics you can work on

Software development page on the website: https://world.openfoodfacts.org/development

Needs

There is many issues, categorized by topics, see:

Principles

Our goal is to follow and keep few and simple guidelines.

  1. Discuss the topics or issues or functionalities you want to work on. The slack workspace is the best choice for it.
  2. 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.
  3. If you want to work on an existing issue, tell everyone in the issue's Github comments.
  4. 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 PRs.
  5. The coding style is defined in the .editorconfig file. Many editors support EditorConfig, check yours: https://editorconfig.org

Inspirations