Skip to content

Commit

Permalink
added CONTRIBUTING.md file for better community contribution #170
Browse files Browse the repository at this point in the history
  • Loading branch information
ducin committed May 10, 2015
1 parent c0dc1c4 commit 3d18588
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
The authors of `faker.js` has put lots of effort to create a useful and handy
library. There is still a lot of things to be done, so all contributions are
welcome! If you can make `faker.js` better, please read the following guide.

# Important

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

## Support

`faker.js` relies on [commonJS](http://www.commonjs.org/) 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](http://gulpjs.com/) (see [gulpfile](build/gulpfile.js)), destination directory is [build/build](build/build)
* The documentation is auto-generated, basing on [build/src](build/src) markdown sources. If you modify the main [Readme.md](Readme.md) file, the PR will be rejected, since it will be overwritten by the upcoming `gulp` execution
* The tests are executing `mocha` against all js contents of [test](test) directory

## Architecture

The sources are located in the [lib](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](lib/locales).

0 comments on commit 3d18588

Please sign in to comment.