File: CONTRIBUTING.md

package info (click to toggle)
node-lunr 2.3.8~dfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 608 kB
  • sloc: javascript: 5,267; makefile: 105; sh: 61
file content (20 lines) | stat: -rw-r--r-- 858 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
Contributions are very welcome. To make the process as easy as possible please follow these steps:

* Open an issue detailing the bug you've found, or the feature you wish to add.  Simplified working examples using something like [jsFiddle](http://jsfiddle.net) make it easier to diagnose your problem.
* Add tests for your code (so I don't accidentally break it in the future).
* Don't change version numbers or make new builds as part of your changes.
* Don't change the built versions of the library; only make changes to code in the `lib` directory.

# Developer Dependencies

A JavaScript runtime is required for building the library.

Run the tests (using PhantomJS):

    make test

The tests can also be run in the browser by starting the test server:

    make server

This will start a server on port 3000, the tests are then available at `/test`.