Changes

Jump to navigation Jump to search
no edit summary
Line 7: Line 7:  
The most easy and quick way to contribute to the taxonomies, is to tell us about an issue, even if it is not related to taxonomies. If you see an ingredient that is not recognised, a category that is not translated or a NOVA-score that is not computed, it might be a taxonomy issue.
 
The most easy and quick way to contribute to the taxonomies, is to tell us about an issue, even if it is not related to taxonomies. If you see an ingredient that is not recognised, a category that is not translated or a NOVA-score that is not computed, it might be a taxonomy issue.
   −
Tell us on Twitter with #openfoodfacts, in our Facebook channel, mail us on contact@openfoodfacts.org, or on Slack. And we will take care of it.  
+
Tell us on Twitter with #openfoodfacts, in our Facebook channel, mail us on contact@openfoodfacts.org, or on Slack (#contributors or #taxonomy channel). And we will try take care of it.  
    
== Editor ==
 
== Editor ==
A special editor has been developed to help us.
+
A special editor has been developed to help us. '''a preview ('''beware your change will be lost for now''')''' is available at https://ui.taxonomy.openfoodfacts.net/ but it's not yet really ergonomic. See also [[Taxonomy editor]].
 +
 
 +
If you are a UX designer or developper, you can contribute to build it: http://openfoodfacts.github.io/taxonomy-editor/, or report bug and feature requests as a simple user.
    
== Github ==
 
== Github ==
 
The most complicated way goes through Github. This option is only for those that are familiar with computers, downloading applications and editing large files.
 
The most complicated way goes through Github. This option is only for those that are familiar with computers, downloading applications and editing large files.
 +
 
=== Installing Github-client ===
 
=== Installing Github-client ===
=== Forking ===
+
In principle it is possible to do the work on the Github-website. Unfortunately the files related to taxonomies grew large and working on the website is not always possible. To circumvent this you need to install a Github-client: [https://desktop.github.com Github Desktop] ([https://github.com/shiftkey/desktop/releases Linux version]).
 +
 
 +
You also need a editor to work with the large text files. Try [https://notepad-plus-plus.org Notepad++] on Windows or [https://macromates.com TextMate] on MacOS.
 +
 
 +
Once you have these installed, you are ready to go. By the way do not forget to create your account on Github.
 +
 
 +
=== Forking and branching ===
 +
For those that are new to Github and collaborative editing, I'll start with some basics. First you need to make a copy of the OFF repository (all the code, taxonomies and documentation). This is called forking. You will be working on your own copy. To do this forking look for the command '''Clone Repository''' in the client. When you want make a set of changes you first need to make a copy of your local repository (called main branch). You will edit this copy. The client will ask you to name this branch. Please add your handle (Github/Slack) to that name, so we can identify you easily. And add a description to that name, such as greekTranslations, newLabels. Thus the branch name will be something like '''myhandle-someTranslations'''. Now you are setup to start editing.
 +
 
 
=== Editing ===
 
=== Editing ===
 
=== Pull request ===
 
=== Pull request ===
Line 31: Line 42:     
After you changes have been accepted and the pull request is closed by OFF, throw away the branch on your side. Try to start each new edit-session with a new branch.
 
After you changes have been accepted and the pull request is closed by OFF, throw away the branch on your side. Try to start each new edit-session with a new branch.
 +
 +
== Testing ==
 +
After pushing (or creating a pull request) your version to Github, a series of tests will be launched. These tests will check whether your changes did not break something. If a test fails you will see the notice '''Some checks were not successful'''. For changes to taxonomies this probably happens in '''Pull Requests / Perl unit tests (pull_request)'''. It is marked by a red cross.
 +
 +
Then you need to figure out what to do. The easiest is to leave it to the team to have a look at it. Decoding the test feedbacks is quite obscure.
 +
 +
If you feel up to it, have a look the details of the test. Search for '''fail''' in this document. It will show you where the error occurred. Maybe you can solve it by re-editing you files, but more probably you need to dive in the testing files. Check the instructions in [[Taxonomy testing]] out.
 +
 +
== Taxonomy deployment ==
 +
Changes to taxonomies on GitHub are not deployed instantly, they need to be built, deployed, and products need to be re-processed with the new taxonomy.
 +
* [[How to build and deploy taxonomies]]
 +
 +
==Finding new opportunities for taxonomization==
 +
*A good trick to find candidates for taxonomization is
 +
  * https://world.openfoodfacts.org/categories?filter=-
 +
  * https://world.openfoodfacts.org/labels?filter=-
 +
  * https://world.openfoodfacts.org/origins?filter=-
 +
  * https://world.openfoodfacts.org/ingredients?filter=-
 +
*Everything in italics is up for grabs
 +
 +
== The future: Taxonomy editor ==
 +
We have [https://ui.taxonomy.openfoodfacts.net/ a prototype to allow editing taxonomies]. Please do not using for actual taxonomy work for now. The source code and bug report/feature requests are [https://github.com/openfoodfacts/taxonomy-editor located on GitHub]. We would welcome feedback on it.
 +
 
[[Category:Taxonomies]]
 
[[Category:Taxonomies]]
 
[[Category:Maintenance]]
 
[[Category:Maintenance]]
199

edits

Navigation menu