Skip to content

Commit

Permalink
docs: update tutorial to add a price (#157)
Browse files Browse the repository at this point in the history
  • Loading branch information
raphodn authored Jan 24, 2024
1 parent af856ea commit 0ebbbe0
Showing 1 changed file with 19 additions and 13 deletions.
32 changes: 19 additions & 13 deletions docs/add-a-price.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,37 @@
# Contribute by adding a price
# Contribute by adding prices

## Single price mode

This tutorial is a step-by-step guide to add a price using [the web interface](https://prices.openfoodfacts.org/app/). If you have any questions, please ask us on [Slack](https://openfoodfacts.slack.com), on the #prices channel!

To add a price, we need some information, such as the product price, the location (=store), a proof photo, etc.

Only the prices of food products are currently accepted.

## Step 1: Take a picture of the price tag + product
### Step 1: Identify the product

We need a picture of the price tag that acts as a proof so that the data can be verified independently. Ideally, the image should contain both the price tag and the product. The product should be clearly visible, and the price tag should be readable.
Identifing the product helps users know if they have scanned the right product to start with. We'll display info from Open Food Facts database, as well as the number of prices already available in the Open Prices database.

[![Examples of good and bad proof pictures](assets/img/proof-examples.png)](assets/img/proof-examples.png)
The steps to add a product differ depending on whether the product is:
- with a barcode
- or raw (fruits, vegetables)

On the first picture, the price tag and the product are visible. However, on the second picture, it's difficult to recognize the product using the photo alone.
If it doesn't have a barcode (raw products), you should select the category among the dropdown list. Not all categories are available yet, so if you can't find the right one, please let us know. Support for other units (e.g. 1 apple) is not yet available, but will be added soon.

### Step 2: Add the price (with a proof)

## Step 2: Add the price
For raw products, the price for 1 kg is expected.

The steps to add a price differ depending on whether the product is raw (fruits, vegetables) or with a barcode.
If the price is discounted, we currently expect the full price to be provided (improvements coming soon).

If it has a barcode, you need to scan it, so that we can identify the product. You should then add the price for a single product (1 unit).
We need a picture of the price tag that acts as a proof so that the data can be verified independently. Ideally, the image should contain both the price tag and the product. The product should be clearly visible, and the price tag should be readable.

If it doesn't have a barcode (raw products), you should first select the category among the dropdown list, then add the price for 1 kg of product. Not all categories are available yet, so if you can't find the right one, please let us know. Support for other units (e.g. 1 apple) is not yet available, but will be added soon.
[![Examples of good and bad proof pictures](assets/img/proof-examples.png)](assets/img/proof-examples.png)

## Step 3: Add the location
On the first picture, the price tag and the product are visible. However, on the second picture, it's difficult to recognize the product using the photo alone.

The location is the store where the product was found. This can be a supermarket, a local store, a farmer's market, etc. The only requirement is that it is a physical location where you can buy food. The location needs to be registered in Open Street Map, otherwise you won't be able to select it. If your store is not in Open Street Map, you can add it there first (ask for help if you're not familiar with Open Street Map!).
### Step 3: Add the location & date

## Step 4: Add the date
The location is the store where the product was found. This can be a supermarket, a local store, a farmer's market, etc. The only requirement is that it is a physical location where you can buy food. The location needs to be registered in Open Street Map, otherwise you won't be able to select it. If your store is not in Open Street Map, you can add it there first (ask for help if you're not familiar with Open Street Map!).

This is when you found the price. This is important because prices change over time, and we want to be able to track these changes.
The date is when you found the price. It can be different from the date you actually add the price. This is important because prices change over time, and we want to be able to track these changes.

0 comments on commit 0ebbbe0

Please sign in to comment.