Skip to content

Latest commit

 

History

History
119 lines (77 loc) · 6.08 KB

CONTRIBUTING.md

File metadata and controls

119 lines (77 loc) · 6.08 KB

Building

We have predefined run configurations for Android Studio and Visual Studio Code

In order to run the application, make sure you are in the packages/smooth_app directory and run these commands:

  • flutter pub get .
  • On Android 🤖: flutter run -t lib/entrypoints/android/main_google_play.dart
  • On iOS/macOS 🍎: flutter run -t lib/entrypoints/ios/main_ios.dart

Contributing

  • You don't have to do anything to the CHANGELOG.md yourself, this is done automatically.

  • Please ensure to add a before/after screenshot when doing a PR that has visual impacts.

  • Please name your pull request following this scheme: type: What you did this allows us to automatically generate the changelog. Following types are allowed:

    • feat, for Features
    • fix, for Bug Fixes
    • docs, for Documentation
    • ci, for Automation
    • refactor, for code Refactoring
    • chore, for Miscellaneous things

Dev Mode

  • How to activate it: We now have a in-app dev mode which allows you to debug things faster, or access not-ready-for-primetime features. You can access it by going to Preferences screen > Contribute > Software Development, and then enabling Dev Mode.

  • Feel free to file an issue if you'd like new switches in this dev mode.

  • You can also add new flags for your features.

Internationalization

Crowdin Action

Error reporting - Sentry

Track crashes

Contributing - What can I work on ?

Are you a developer? A graphic designer? Full of innovative ideas to help users improve their mode of consumption? Then join us! We are always looking for new contributors, if you're willing to help please let us know, we'll be pleased to introduce you to the project.

Weekly meetings

We usually meet on Thursdays at 15:30 GMT (UTC) at https://meet.google.com/gnp-frks-esc. Please email pierre@openfoodfacts.org if you want to be added to the Calendar invite for convenience.

Wiki & Doc

V1 Roadmap (Shipped on June 15th 2022 for Vivatech)

  • We should be able to ship the Smoothie code to the main listing on Android and iOS
  • The app should be able to scan very well
  • Minimal Road to Scores (you should be able to get Nutri-Score and Eco-Score on any unknown/uncomplete product in 2 minutes, using editing and/or product addition
    • Initial photo taking, good ingredient extraction, Nutrition input, Category input (TODO)
  • Database migration for existing Android and iOS users (minimum: history, credentials, if possible with allergen alerts, lists)
  • A Welcome scan card that can broadcast a message from the Open Food Facts team per country/language (Tagline)
  • On-page photo refresh capabilities (Not working well)
  • V1 tracking

V1.1

  • Allow to switch languages
  • Allow to expand search results to the world

Next

Scanning

Contribution

  • Speedup image upload
  • Improve the scan experience when Nutri-Score and Eco-Score are not present (some people don't click on the card even if fully unhelpful)
  • Offer a faster editing system for power users (and potentially all)
    • Add power edit mode that concatenates all the editable things for faster contribution
  • Add a list of things to do contribution wise on the product (via Knowledge Panels or natively), or introduce a "Raw data" mode for power contributors

Value added in browsing

  • Clarify the alternative product proposition
  • Reintroduce the portion calculator

Gamification

  • Add the number of contributions when logged in
  • Integration with openfoodfacts-events

Settings

  • Revamped settings that are less cluttered, and can make way in the future for things the user will go see more often.
  • Personalization system that does not feel weird during setup, where people understand consequence, and where ranking match their expectations even in stretch cases (lack of data on some product, selecting Nutri-Score and all Low-in Nutrients…), where red-lines are clearly shown (allergens) with potential caveats, where solutions are proposed and warning issued in case of lack of data.

Misc

  • Fix HTTP header and contribution comments