Skip to content

Commit b695c63

Browse files
authored
Merge branch 'next' into da-locale-commerce-company
2 parents 6d619ee + 8d7de9f commit b695c63

1 file changed

Lines changed: 5 additions & 4 deletions

File tree

CONTRIBUTING.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,11 @@ If adding new data definitions to Faker, you'll often need to find source data.
4242
- 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).
4343
- It's best to refer to multiple sources and use your own judgement/knowledge to make a sample list of data.
4444

45+
## Adding new locale or updating existing one
46+
47+
After adding new or updating existing locale data, you need to run `pnpm run generate:locales` to generate/update the related files.
48+
If you change more than 20 locale files, please consider splitting your PR into one per category (e.g. person, location).
49+
4550
## Building Faker
4651

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

166-
## Adding new locale or updating existing one
167-
168-
After adding new or updating existing locale data, you need to run `pnpm run generate:locales` to generate/update the related files.
169-
170171
## Deprecation workflow
171172

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

0 commit comments

Comments
 (0)