Line 1: |
Line 1: |
| + | The Open Food Facts software is developed collaboratively by hackers from all around the world. |
| + | |
| 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. | | 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. |
| | | |
Line 10: |
Line 12: |
| ** For those who love i18n see [https://github.com/openfoodfacts/openfoodfacts-server/issues?q=is%3Aopen+is%3Aissue+label%3Atranslations translations] category | | ** For those who love i18n see [https://github.com/openfoodfacts/openfoodfacts-server/issues?q=is%3Aopen+is%3Aissue+label%3Atranslations 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 |