Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
25 lines (17 loc) · 1.29 KB

CONTRIBUTING.md

File metadata and controls

25 lines (17 loc) · 1.29 KB

A lot of effort has been put into faker.js to create a useful and handy library. There are still a lot of things to be done, so all contributions are welcome! If you can make faker.js better, please read the following contribution guide.

Important

  • Please make sure that you run both gulp and tests before making a PR.

Support

faker.js relies on commonJS standard and supports both node.js and the browsers. Keep this in mind, when modifying and/or extending the sources.

Automation

  • The project is being built by gulp (see gulpfile), destination directory is build/build
  • The documentation is auto-generated, based on build/src markdown sources. If you modify the main Readme.md file, the Pull Request will be rejected, since it will be overwritten by the upcoming gulp execution
  • The tests are executing mocha against all js contents of test directory

Architecture

The sources are located in the lib 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.