Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add section & link to translation platform (crowdin) #1180

Merged
merged 1 commit into from
Dec 27, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Loading