Skip to content

Commit

Permalink
docs: mention file limits for locale PRs (#2322)
Browse files Browse the repository at this point in the history
  • Loading branch information
ST-DDT authored Sep 8, 2023
1 parent 630375b commit 8d7de9f
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,11 @@ If adding new data definitions to Faker, you'll often need to find source data.
- But if you are compiling a list of, for example, popular personal names or cities, don't copy directly from a single source (Wikipedia, 'most popular' articles, government data sites etc). A compilation of facts [can be copyrighted](https://en.wikipedia.org/wiki/Copyright_in_compilation).
- It's best to refer to multiple sources and use your own judgement/knowledge to make a sample list of data.

## Adding new locale or updating existing one

After adding new or updating existing locale data, you need to run `pnpm run generate:locales` to generate/update the related files.
If you change more than 20 locale files, please consider splitting your PR into one per category (e.g. person, location).

## Building Faker

The project is being built by [esbuild](https://esbuild.github.io) (see [bundle.ts](scripts/bundle.ts))
Expand Down Expand Up @@ -163,10 +168,6 @@ describe('someModule', () => {
});
```

## Adding new locale or updating existing one

After adding new or updating existing locale data, you need to run `pnpm run generate:locales` to generate/update the related files.

## Deprecation workflow

If you ever find yourself deprecating something in the source code, you can follow these steps to save yourself (and the reviewers) some trouble.
Expand Down

0 comments on commit 8d7de9f

Please sign in to comment.