Skip to content

Commit

Permalink
docs: add section & link to translation platform (crowdin) (#1180)
Browse files Browse the repository at this point in the history
  • Loading branch information
k127 authored Dec 27, 2024
1 parent df4d3e6 commit d20fec1
Showing 1 changed file with 15 additions and 6 deletions.
21 changes: 15 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,21 @@
# Contributing to Open Prices Frontend

## Installation
## Help with translating

The translation for all openfoodfacts GitHub repositories, including this one, is done in a Crowdin project: <https://crowdin.com/project/openfoodfacts>

In Crowdin, after selecting the target language, add `open-prices-frontend` as a filter to check the translations that only belong to this GitHub repository.


## Help with developing

### Installation

If you don't already have Node.js install, we recommend using [`nvm`](https://github.com/nvm-sh/nvm) to manage different node versions.

We use the [yarn](https://yarnpkg.com/getting-started/install) for package management.

## Run the project
### Run the project

1. Install/update packages with command `yarn`
2. Run in development mode with `yarn dev`
Expand All @@ -16,27 +25,27 @@ We use the [yarn](https://yarnpkg.com/getting-started/install) for package manag
3. Run the back-end on your device. To do so, get and run the code of the server here: <https://github.com/openfoodfacts/open-prices>.
4. You can start your first contribution :tada:

## Build
### Build

```sh
yarn build
```

## Lint
### Lint

```sh
yarn lint
```

There is also a pre-commit configuration set up with [husky](https://typicode.github.io/husky/) and [lint-staged](https://github.com/lint-staged/lint-staged).

## Tests
### Tests

```sh
yarn test
```

## Update packages
### Update packages

```sh
// 1) list packages to update
Expand Down

0 comments on commit d20fec1

Please sign in to comment.