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 14: |
Line 16: |
| | | |
| == 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. |
Line 20: |
Line 24: |
| # 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'''. 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 |