Skip to content

Commit

Permalink
Add contributors guide
Browse files Browse the repository at this point in the history
  • Loading branch information
justincy committed Apr 29, 2014
1 parent 9bb596c commit 1f2949e
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Generate genealogy search links for a ton of websites.
* [Installation Instructions](#install)
* [Person Data Schema](#schema)
* [Supported Sites](#sites)
* [Contributor's Guide](#contribute)

## Usage

Expand Down Expand Up @@ -238,3 +239,23 @@ var url = gensearch('worldvitalrecords', data, [options]);
| option | default |
|--------|---------|
| `dateRange` | 2 |


## Contribute

#### Setup

```
git clone https://github.com/genealogysystems/gen-search.git
cd gen-search
npm install
```

#### Add a site

1. Create the site file in the [src/sites](https://github.com/genealogysystems/gen-search/tree/master/src/sites) directory. Look at [archives.js](https://github.com/genealogysystems/gen-search/blob/master/src/sites/archives.js) for a simple example or [familysearch.js](https://github.com/genealogysystems/gen-search/blob/master/src/sites/familysearch.js) for a more complex example.
2. Add the new site to the [src/search.js] site list, in alphabetical order please.
3. Add a test file in the [test/sites](https://github.com/genealogysystems/gen-search/tree/master/test/sites) directory. Look at any of the other site test files for an example.
4. Run tests with `npm test`. The `gensearch.js` file will be automatically built with [browserify](https://github.com/substack/node-browserify) before the tests are run.
5. Document the new site in the README file, in alphabetical order please. Be sure to add a link in the site list just before the site specific docs.
6. Commit and submit a pull request.

0 comments on commit 1f2949e

Please sign in to comment.