aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorST-DDT <[email protected]>2023-09-08 11:30:21 +0200
committerGitHub <[email protected]>2023-09-08 11:30:21 +0200
commit8d7de9f6f639fc36bbd5b4324cc9b25df9c30f52 (patch)
tree153708865f7a354398955c5e9128b786bd46ec30 /CONTRIBUTING.md
parent630375b6903719417c47db59844d7bc36d0b1269 (diff)
downloadfaker-8d7de9f6f639fc36bbd5b4324cc9b25df9c30f52.tar.xz
faker-8d7de9f6f639fc36bbd5b4324cc9b25df9c30f52.zip
docs: mention file limits for locale PRs (#2322)
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md9
1 files changed, 5 insertions, 4 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index aebcf404..75ce7166 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -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))
@@ -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.