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.

Sign up for GitHub

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

Jump to bottom

docs: mention file limits for locale PRs #2322

Merged
merged 3 commits into from Sep 8, 2023
Merged

docs: mention file limits for locale PRs #2322

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2fa3dc3
docs: mention file limits for locale PRs
ST-DDT Aug 17, 2023
cf91384
Merge branch 'next' into docs/contributing/reviewer-sanity
ST-DDT Aug 20, 2023
ff52c0d
Merge branch 'next' into docs/contributing/reviewer-sanity
ST-DDT Sep 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
9 changes: 5 additions & 4 deletions CONTRIBUTING.md
View file
Open in desktop
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
xDivisionByZerox marked this conversation as resolved.
Show resolved Hide resolved

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