Difference between revisions of "Software Development"

From Open Food Facts EN
Jump to navigation Jump to search
(+ branch name)
m
Line 25: Line 25:
 
# 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 it ''issue/[issue_number]-[name]'', ex.: ''issue/1630-name-of-the-issue''
+
## 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.
 
## 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

Revision as of 17:55, 24 January 2019

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.

All our code is on GitHub : https://github.com/openfoodfacts/

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.
    1. It's cool to name a branch: issue/[issue_number]-[name]; ex.: issue/1630-name-of-the-issue
    2. 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.
  5. 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