How to Contribute

Table of Contents

  1. Get Started
    1. Preparing Environment
    2. Running Tests
  2. Working on Documentations
  3. How the code is organized
    1. SQL Drivers

Get Started

Three steps:

  1. Install databases we intend to support, namely MySQL, PostgreSQL, and SQLite
  2. Install node_modules (which might take long)
  3. Happy hacking

Preparing Environment

$ brew install mysql postgres sqlite
$ brew service start mysql
$ brew service start postgres

Running Tests

$ npm install
# prepare table schema, run all tests
$ npm run test
# run unit tests
$ npm run test:unit
# run integration tests
$ npm run test:integration
# run typescript definition tests
$ npm run test:dts

To be more specific, we can filter test files and cases:

$ npm run test -- test/unit/test.connect.js --grep "should work"
$ npm run test:unit --grep "=> Sequelize adapter"
$ npm run test:mysql --grep "bone.toJSON()"

If --grep [pattern] isn’t specific enough, we can always insert .only:

describe('=> Spell', function() {
  it.only('supports error convention with nodeify', async function() {
    // asserts

Please remember to remove them before commit.

Working on Documentations

The Leoric documentation is served with Github Pages, which requries Jekyll to build. See the Jekyll on macOS instructions, refer to the guide Install Ruby on Mac, or use Moncef Belyamani’s Ruby setup scripts. If you only intend to use Jekyll, you can install Ruby with Homebrew without a version manager. After Ruby is installed, follow instructions to install Jekyll.

If your network struggles to connect to, consider changing the Ruby Gems source in docs/Gemfile:

diff --git a/docs/Gemfile b/docs/Gemfile
index 4382725..b4dba82 100644
--- a/docs/Gemfile
+++ b/docs/Gemfile
@@ -1,4 +1,4 @@
-source ""
+source ""

When bundle install completes, you can now build docs locally:

$ cd docs  # if you're not at this directory yet
$ jekyll serve
Configuration file: leoric/docs/_config.yml
            Source: leoric/docs
       Destination: leoric/docs/_site
 Incremental build: disabled. Enable with --incremental
   GitHub Metadata: No GitHub API authentication could be found. Some fields may be missing or have incorrect data.
                    done in 3.73 seconds.
 Auto-regeneration: enabled for 'leoric/docs'
    Server address:
  Server running... press ctrl-c to stop.

The documentation will be available at http://localhost:4000/.

How the code is organized

The code basically breaks into following layers (from bottom to top):

SQL Drivers

The model driver provides following abilities: