Skip to content

Commit

Permalink
CONTRIBUTING address review comments
Browse files Browse the repository at this point in the history
  • Loading branch information
kingthorin authored Oct 16, 2024
1 parent 1e838cb commit 4b22912
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,14 @@ In order to keep Datafaker slim and focused the project generally attempts to av

## Languages and countries

Localization files are located in folder `src/main/resources`
1. Country-specific values are stored in files `_COUNTRY.yml` (e.g. `_AL.yml` for Albania)
* these are value that are the same in all languages in this country (e.g. phone country code, passport number pattern etc.)
2. Language-specific values are stored in files `language.yml` (e.g. `it.yml` for Italian)
* these are cities, streets, names etc. in that languages.
3. In files `language-COUNTRY.yml`, we store values specific for this language and country
Localization files are located in folder `src/main/resources`.
1. Country-specific values are stored in files `_COUNTRY.yml` (e.g. `_AL.yml` for Albania).
* these are value that are the same in all languages in this country (e.g. phone country code, passport number pattern, etc.).
2. Language-specific values are stored in files `language.yml` (e.g. `it.yml` for Italian).
* these are cities, streets, names etc. in that language.
3. In files `language-COUNTRY.yml`, we store values specific for this language and country.
* e.g. `ru-MD.yml` contains Moldovan city names in Russian language (that is widely used in Moldova).

After adding a new country or language, don't forget to update
* constant `net.datafaker.providers.base.Locality.LOCALES`
* tests in `LocalityTest.java`
After adding a new country or language, don't forget to update:
* constant `net.datafaker.providers.base.Locality.LOCALES`.
* tests in `LocalityTest.java`.

0 comments on commit 4b22912

Please sign in to comment.