| 1 | A lot of effort has been put into `faker.js` to create a useful and handy
|
| 2 | library. There are still a lot of things to be done, so all contributions are
|
| 3 | welcome! If you can make `faker.js` better, please read the following contribution guide.
|
| 4 |
|
| 5 | # Important
|
| 6 |
|
| 7 | * Please make sure that you run both `gulp` and tests before making a PR.
|
| 8 |
|
| 9 | ## Support
|
| 10 |
|
| 11 | `faker.js` relies on [commonJS](http://www.commonjs.org/) standard and supports both node.js and the
|
| 12 | browsers. Keep this in mind, when modifying and/or extending the sources.
|
| 13 |
|
| 14 | ## Automation
|
| 15 |
|
| 16 | * The project is being built by [gulp](http://gulpjs.com/) (see [gulpfile](build/gulpfile.js)), destination directory is [build/build](build/build)
|
| 17 | * The documentation is auto-generated, based on [build/src](build/src) markdown sources. If you modify the main [Readme.md](Readme.md) file, the Pull Request will be rejected, since it will be overwritten by the upcoming `gulp` execution
|
| 18 | * The tests are executing `mocha` against all js contents of [test](test) directory
|
| 19 |
|
| 20 | ## Architecture
|
| 21 |
|
| 22 | The sources are located in the [lib](lib) directory. All fake data generators are
|
| 23 | divided into namespaces (each namespace being a separate module). Most of the
|
| 24 | generators use the *definitions*, which are just plain JavaScript
|
| 25 | objects/arrays/strings that are separate for each [locale](lib/locales).
|