Difference between revisions of "Tech Team"
Jump to navigation
Jump to search
(+ existing issues) |
|||
(9 intermediate revisions by 4 users not shown) | |||
Line 1: | Line 1: | ||
− | We have a lot of development work to do: | + | 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, within the backend code as templates); | ||
+ | * iOS native (Swift); | ||
+ | * Android native (Java); | ||
+ | * Robotoff, our machine learning service (Python) | ||
+ | * Hunger Games, our annotation engine (Javascript) | ||
+ | * Our various SDKs (Python, Ruby, Dart, PHP…) | ||
+ | * Build new cool reuses etc... | ||
All our code is on GitHub : [https://github.com/openfoodfacts/ https://github.com/openfoodfacts/] | 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 | ||
== Needs == | == Needs == | ||
Line 8: | Line 20: | ||
* [https://github.com/openfoodfacts/openfoodfacts-server/issues Website, backend and API issues] | * [https://github.com/openfoodfacts/openfoodfacts-server/issues Website, backend and API 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 | ** 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 | ||
− | ** For those who love i18n see [https://github.com/openfoodfacts/openfoodfacts-server/issues?q=is%3Aopen+is%3Aissue+label% | + | ** 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] | ** See [https://github.com/openfoodfacts/openfoodfacts-server/labels all the categories] | ||
− | * [https://github.com/openfoodfacts/openfoodfacts-androidapp Android app issues] | + | * [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] | * [https://github.com/openfoodfacts/ All the repositories] | ||
== Principles == | == Principles == | ||
+ | |||
+ | 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'''. 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. | + | # 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 | # '''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 |
Revision as of 14:18, 2 May 2021
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, within the backend code as templates);
- iOS native (Swift);
- Android native (Java);
- Robotoff, our machine learning service (Python)
- Hunger Games, our annotation engine (Javascript)
- Our various SDKs (Python, Ruby, Dart, PHP…)
- Build new cool reuses etc...
All our code is on GitHub : https://github.com/openfoodfacts/
Software development page on the website: https://world.openfoodfacts.org/development
Needs
There is many issues, categorized by topics, see:
- Website, backend and API issues
- For beginners see First Good Issue category
- For those who love i18n see translations category
- See all the categories
- Android app issues
- iOS app issues
- Open Food Facts AI issues
- All the repositories
Principles
Our goal is to follow and keep few and simple guidelines.
- discuss the topics or issues or functionalities you want to work on. The 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 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; 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