Tech Team: Difference between revisions
(rework of the page to be tech team page) |
m (Mostly fixing typos) |
||
| Line 9: | Line 9: | ||
Providing tools is essential to be able to [[Data Contribution Team|grow the database]] as fast as possible and maintain its quality. | Providing tools is essential to be able to [[Data Contribution Team|grow the database]] as fast as possible and maintain its quality. | ||
The mobile app and the main website | The mobile app and the main website reach a large public and provide health and environment information. They also enable crowdsourcing the database at a large scale. Their user experience is very important. | ||
The other tools | The other tools help tracking data quality, fixing errors, augmenting contribution through machine learning etc. | ||
Having qualitative technical documentation helps a lot reaching new contributors that can help us more efficiently. | Having qualitative technical documentation helps a lot reaching new contributors that can help us more efficiently. | ||
| Line 20: | Line 20: | ||
[https://slack.openfoodfacts.org/ Slack channels]: | [https://slack.openfoodfacts.org/ Slack channels]: | ||
*<nowiki>#dev - is a general channel around development</nowiki> | *<nowiki>#dev - is a general channel around development</nowiki> | ||
*#infrastructure - is about managing servers, installing software, etc. | *#<nowiki>#infrastructure - is about managing servers, installing software, etc.</nowiki> | ||
*#documentation - about documentation | *#<nowiki>#documentation - about documentation</nowiki> | ||
* | *All our software projects have their own channels, for example #product-opener (main server), #mobile_app. You may find specific channels in the README of each project. | ||
*There are also channels specific to languages: #perl, #flutter, #python, etc. to ask questions specific to the language or develop the SDK | *There are also channels specific to languages: #perl, #flutter, #python, etc. to ask questions specific to the language or develop the SDK | ||
All developments happens on '''GitHub''': https://github.com/openfoodfacts/ (even infrastructure has | All developments happens on '''GitHub''': https://github.com/openfoodfacts/ (even infrastructure has its repo) | ||
Some projects have weekly or bimonthly meeting, see README of each projects or [[Events|community calendar.]] | Some projects have weekly or bimonthly meeting, see the README of each projects or [[Events|community calendar.]] | ||
We have a monthly infrastructure meeting (see [[Events|community calendar)]] | We have a monthly infrastructure meeting (see [[Events|community calendar).]] | ||
=== Activities === | === Activities === | ||
| Line 34: | Line 34: | ||
* Software development | * Software development | ||
** there is a large variety of projects to develop. see https://github.com/openfoodfacts/ | ** there is a large variety of projects to develop. see https://github.com/openfoodfacts/ | ||
** if you want to help with the core of the project, consider learning | ** if you want to help with the core of the project, consider learning Perl (server) or Flutter (mobile app) | ||
** new ideas are also welcome | ** new ideas are also welcome | ||
** after one or two successful merge PR you can ask direct access to a repository | ** after one or two successful merge PR you can ask direct access to a repository | ||
| Line 48: | Line 48: | ||
* Infrastructure | * Infrastructure | ||
** if you have a good level of expertise in Linux, ZFS, Proxmox or some specific architecture, we would really welcome your participation. see [https://github.com/openfoodfacts/openfoodfacts-infrastructure/ openfoodfacts-infrastructure repository] | ** if you have a good level of expertise in Linux, ZFS, Proxmox or some specific architecture, we would really welcome your participation. see [https://github.com/openfoodfacts/openfoodfacts-infrastructure/ openfoodfacts-infrastructure repository] | ||
** [https://github.com/openfoodfacts/openfoodfacts-monitoring/ monitoring] is also | ** [https://github.com/openfoodfacts/openfoodfacts-monitoring/ monitoring] is also important | ||
** contributing in docker in projects, and CI/CD actions is also much appreciated | ** contributing in docker in projects, and CI/CD actions is also much appreciated | ||
* Machine learning | * Machine learning | ||
| Line 56: | Line 56: | ||
=== Programs === | === Programs === | ||
We regularly participate in programs like Google Summer Of Code, Google Season of docs, [https://outreachy.org/ outreachy], [https://dataforgood.fr/ data for good], | |||
If you are interested in mentoring or participating, or if you propose another program, reach us. | If you are interested in mentoring or participating, or if you would like to propose another program, reach out to us. | ||
== Principles == | == Principles == | ||
Revision as of 08:21, 24 February 2023
What
The Open Food Facts software is developed collaboratively by hackers from all around the world.
Technical skills are really appreciated in a wide variety of domains.
Every thing we code is under a free software license (possibly AGPL)
Why
Providing tools is essential to be able to grow the database as fast as possible and maintain its quality.
The mobile app and the main website reach a large public and provide health and environment information. They also enable crowdsourcing the database at a large scale. Their user experience is very important.
The other tools help tracking data quality, fixing errors, augmenting contribution through machine learning etc.
Having qualitative technical documentation helps a lot reaching new contributors that can help us more efficiently.
Writing SDKs and API documentation helps lower the entry for database reuse projects.
Connect
- #dev - is a general channel around development
- #infrastructure - is about managing servers, installing software, etc.
- #documentation - about documentation
- All our software projects have their own channels, for example #product-opener (main server), #mobile_app. You may find specific channels in the README of each project.
- There are also channels specific to languages: #perl, #flutter, #python, etc. to ask questions specific to the language or develop the SDK
All developments happens on GitHub: https://github.com/openfoodfacts/ (even infrastructure has its repo)
Some projects have weekly or bimonthly meeting, see the README of each projects or community calendar.
We have a monthly infrastructure meeting (see community calendar).
Activities
- Software development
- there is a large variety of projects to develop. see https://github.com/openfoodfacts/
- if you want to help with the core of the project, consider learning Perl (server) or Flutter (mobile app)
- new ideas are also welcome
- after one or two successful merge PR you can ask direct access to a repository
- For beginners we often try to add a good-first-issue label on accessible issues
- Project management / product design / design
- skills in project or product design can really help: triaging bug, imagining new UI and UX
- also if you have skills for design do not hesitate to propose your skills
- Technical Documentation
- help improve documentation on projects directly (often docs/ folder, but also the README)
- contributing to this wiki is also useful in some cases
- remember that putting good links at the right place is also very efficient
- Infrastructure
- if you have a good level of expertise in Linux, ZFS, Proxmox or some specific architecture, we would really welcome your participation. see openfoodfacts-infrastructure repository
- monitoring is also important
- contributing in docker in projects, and CI/CD actions is also much appreciated
- Machine learning
- robotoff is at the heart of machine learning usage (orchestrator)
- hunger-games is a fantastic tool to contribute data to it
- openfoodfacts-ai is the main repository for machine learning
Programs
We regularly participate in programs like Google Summer Of Code, Google Season of docs, outreachy, data for good,
If you are interested in mentoring or participating, or if you would like to propose another program, reach out to us.
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 PRs.
- It's cool to name a branch:
- The coding style is defined in the
.editorconfigfile. 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