Contributing

So you've found a bug in QueryEngine or what to contribute a new feature? Great. Let's talk about the steps to get your patch into the official query engine repository.

1. Forking and Cloning the Repository

When you go the QueryEngine GitHub Page, there will be a "fork" button up the top right. Click that, it will set you up with your own "copy" of the repository, one that you can work on. Clone out your fork's url to your machine, and get working on it.

2. Configuring your Environment

Once you've cloned out your fork's repository, you'll need to configure your environment for working with QueryEngine. Here are the steps:

1. Install Node.js

2. Install Coffee-Script (which is what Query Engine's source is written in)

   npm install -g coffee-script

3. Install the project specific development dependencies

   npm install

3. Writing Unit Tests

Our unit tests are written with Mocha and can be found in the test directory. We use the BDD interface for writing our unit tests.

Use npm test to run our unit tests.

4. Submitting your Pull Request

Once you're all good, go back to the QueryEngine GitHub Page and click on the "Pull Request" button up the top right, and mention your changes.

Wait a while, and a project maintainer will get to your changes and pull them or provide suggestions what needs more work.

Cheers!