Skip to content

Latest commit

 

History

History
218 lines (151 loc) · 9.58 KB

CONTRIBUTING.md

File metadata and controls

218 lines (151 loc) · 9.58 KB

Contributing

If you find a bug in the code or a mistake in the documentation or want a new feature, you can help us by creating an issue to our repository, or even better, submit a pull request.

  • For small fixes, please feel free to submit a pull request. No worry about creating an issue first.

  • For major changes, please discuss with us via our mailing list and Github first, so we can better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted into the project.

  • Generally we name a branch using this pattern <your 2-3 letters initial>/<topic>. For example, @kanitw's branch regarding scale type might be called kw/scale-type.

See our issue and pull request templates for more information.

Looking for a Task to Contribute

This document lists tasks for contributors, starting from smaller tasks to a larger task. You can also find all tasks with "help-wanted" label in the issue tracker.

Documentation and Website

The website is under site/ and the documentation is under site/docs/. We use Github Pages to publish our documentation when we release a new version. To contribute changes to the documentation or website, simply submit a pull request that changes the corresponding markdown files in site/.

The images that are shown on the homepage and in the gallery have to be generated with npm run images. To run the script, you need to install gnu parallel. (For Mac, you can simply do brew install parallel.)

Since we only publish the Github Pages when we release a new version, it might be slightly outdated compared to master. For development, once you have setup the repository, you can run npm run site to serve the github page locally at http://localhost:4000/vega-lite/.

Development Guide

Repository Setup

  1. Make sure you have node.js. For mac users, we recommend using homebrew and simply run:
brew install node
  1. Clone this repository and cd into your local clone of the repository, and install all the npm dependencies:
git clone https://github.com/vega/vega-lite.git
cd vega-lite
npm install

Now you should be able to build and test the code.

  1. To make the gallery work, you need to install bower and its dependencies:
npm install -g bower
bower install
  1. To serve the website and documentation, you will need ruby, bundler and Jekyll.

For ruby, Mac users can use homebrew to add it:

brew install ruby

For bundler:

gem install bundler

For jekyll and its dependencies, because we already have the Gemfile in the repo, you can simply run:

bundle install

Directory Structure

  • _layouts/ – Our website and documentation's Jekyll layout files.

  • bin/ – Scripts for using Vega-Lite with command line.

  • data/ – Example data.

  • site/ – Vega-Lite website including documentation.

  • examples/ – Example Vega-Lite specifications.

    • examples/vl-examples.json lists all examples under examples/. Similarly, examples/docs/vl-docs-examples.json lists all examples under examples/docs.

  • lib/ contains JSON schema's schema.json

  • scripts/ - Scripts for NPM commands.

  • site/ - Misc files for serving the website and gallery

  • src/ - Main source code directory.

    • src/vl.ts is the root file for Vega-Lite codebase that exports the global vl object. Other files under src/ reflect namespace structure. All methods for vl.xxx will be in either src/xxx.ts or src/xxx/xxx.ts. For example, vl.channel.* methods are in src/channel.ts. vl.compile is in src/compile/compile.ts.
    • All interface for Vega-Lite syntax should be declared at the top-level of the src/ folder.

  • test/ - Code for unit testing. test's structure reflects src's' directory structure. For example, test/compile/ test files inside src/compile/.

    • Note that we prepend /* tslint:disable:quotemark */ to all files under test/compile to allow putting JSON spec in tests directly without getting lint errors.

  • typings/ - TypeScript typing declaration for dependencies. Some of them are downloaded from the TypeStrong community.

Commands

This section lists commands that are commonly used during development. See package.json for other commands.

Build

You can run npm run build to compile Vega-Lite and regenerate vega-lite-schema.json.

Basic Lint & Test

npm run lint and npm run test run ts-lint and all unit-tests respectively. These two commands are automatically run by npm start and npm run watch.

Test Coverage

Use npm run cover to see test coverage summary and generate a report inside coverage/lcov-report. You can see if specific lines are covered in the unit test by running open coverage/lcov-report/index.html and browse through the report.

Watch tasks

During development, it can be convenient to rebuild automatically or run tests in the background.

You can run npm run start to start a watcher task that shows the example gallery. Whenever any .ts file changes, the watcher: (1) re-compiles Vega-Lite (2) automatically refreshes the gallery with BrowserSync (3) lints and runs tests (4) regenerates the JSON schema (vega-lite-schema.json)

If you only want subset of these actions, you can use:

  • npm run watch to start a watcher task that do all of above except opening and syncing the gallery.

  • npm run watch:test to start a watcher task that lints and runs tests when any .ts file changes.

  • npm run watch:build to start a watcher task that re-compiles Vega-Lite when .ts files related to VL change.

Website

npm run site. See details in Documentation and Website.

Output diff

We also have commands for observing changes in output Vega spec and output images.

To create baseline Vega output specs from the Vega-Lite specs in examples/, check out the baseline branch (e.g., git checkout master) and run npm x-compile. All compiled specs will be in examples/_original.

Once you develop some features and would like to diff the compiled specs, run npm x-diff. This will compile all examples again and output the diff for changed examples in the console. All compiled specs will be in examples/_output. For changed examples, SVG files will be created in examples/_diff for comparison. You can open those files to inspect visual changes, or run a diff command (e.g., diff examples/_diff/area-base.svg examples/_diff/area.svg).

Deployment

(For team members only) npm run deploy will publish latest code to NPM and Bower and also update github pages, which contains our webpage and documentation. If you want to update only github pages, use npm run deploy:gh.

To use any of these two commands, you will need to install jq i.e., running brew install jq if you use homebrew on mac.

Suggested Programming Environment.

We use the atom editor with the following plug-ins:

  • atom-typescript - This provides us IDE-like features for TS inside Atom including renaming, go to definition, find all references.
  • linter and linter-tslint – These shows tslint errors inside the editor. This is quite important since our Travis run includes linting too. Therefore, if your branch has a linting error, Travis test will fail too.

Tips: If you don't want to see intermediate files (.js, .js.map), you can "Hide VCS Ignored Files" in the tree-view plugin.

Manually Testing with Vega-Editor

To manually test your changes locally, you should have a local instance of Vega Editor and link Vega-Lite to the editor (See Vega Editor's README for instructions).

Developing Vega-Lite and Datalib

Vega-Lite depends on Datalib. If you plan to make changes to datalib and test Vega-Lite without publishing / copying compiled Datalib all the time, use npm link command.

# first link datalib global npm
cd path/to/datalib
npm link
# then link vega-lite to datalib
cd path/to/vega-lite
npm link datalib

Now all the changes you make in Datalib are reflected in your Vega-Lite automatically.

Note

Vega-Lite enables a number of open-source applications including user interface tools (PoleStar and Voyager) and visualization recommender (Compass). Look at their contribute pages if you are interested!

Acknowledgment: This contribution guide is partly inspired by angular.js's CONTRIBUTION.md.