diff options
| author | Matt Mayer <[email protected]> | 2023-03-10 00:40:44 +0700 |
|---|---|---|
| committer | GitHub <[email protected]> | 2023-03-09 17:40:44 +0000 |
| commit | 6ba21c64ca0fe883ed7a9498b5f1539e115c871f (patch) | |
| tree | 99b91bad64452ec0ecf50af801f4a60fe60f6927 /CONTRIBUTING.md | |
| parent | f8926c7b1311e5c1e617289f9ee3760b522bea3f (diff) | |
| download | faker-6ba21c64ca0fe883ed7a9498b5f1539e115c871f.tar.xz faker-6ba21c64ca0fe883ed7a9498b5f1539e115c871f.zip | |
docs: Add 'Sourcing data for definitions' to CONTRIBUTING (#1888)
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index acdf2559..35ed17d1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -21,6 +21,15 @@ The sources are located in the [src](src) directory. All fake data generators are divided into namespaces (each namespace being a separate module). Most of the generators use the _definitions_, which are just plain JavaScript objects/arrays/strings that are separate for each [locale](src/locales). +## Sourcing data for definitions + +If adding new data definitions to Faker, you'll often need to find source data. Note that: + +- Faker must not contain copyrighted materials. +- Facts cannot be copyrighted, so if you are adding or translating a finite, known, list of things such as the names of chemical elements into another language, that's OK. +- 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. + ## Building Faker The project is being built by [esbuild](https://esbuild.github.io) (see [bundle.ts](scripts/bundle.ts)) |