Skip to content

Latest commit

 

History

History
129 lines (92 loc) · 4.67 KB

CONTRIBUTING.md

File metadata and controls

129 lines (92 loc) · 4.67 KB
Raw

Contributing to plotly.js

Opening issues

Search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.

Bug reports must be accompanied with a reproducible example. We recommend using codepen, jsfiddle or jsbin to share your example.

Note that GitHub issues are reserved for bug reports and feature requests only. Implementation questions should be asked on Stack Overflow (tagged plotly) or on community.plot.ly (tagged plotly-js).

Issue labels

We use the following labels to track issues:

Label Purpose
type: bug bug report confirmed by a plotly team member
type: enhancement planned feature or task
type: community issue left open for community input and pull requests
type: maintenace source code cleanup resulting in no enhancement for users
type: duplicate self-explanatory
type: wontfix self-explanatory
status: in progress PRs that required some intial feedback but not ready to merge
status: reviewable PRs that are completed from the author's perspective
status: on hold PRs that are put on hold

Development

Prerequisites:

  • git
  • node.js. We recommend using node.js 4.2.x (LTS). Upgrading and managing node versions can be easily done using nvm or its Windows alternatives.

Step 1 Clone the plotly.js repo and install its dependencies

git clone https://github.com/plotly/plotly.js.git
cd plotly.js
npm install

Step 2 Start the test dashboard

npm run start-test_dashboard

This command bundles up the source files with source maps using browserify, starts a watchify file watcher (making the your dev plotly.js bundle update every time a source file is saved) and opens up a tab in your browser.

Step 3 Open up the console and start developing

Make some modifications to the source, refresh the page and check the results by for example pasting in the console:

Plotly.plot(Tabs.fresh(), [{x:[1,2,3], y:[2,1,2]}]);
  • Tabs.fresh() creates a fresh graph div and return it and
  • Tabs.getGraph() returns the current graph div.

Other npm scripts:

  • npm run preprocess: pre-processes the css and svg source file in js. This script must be run manually when updating the css and svg source files.
  • npm run watch: starts a watchify file watcher just like the test dashboard but without booting up a server.

Testing

Both jasmine and image tests are run on CircleCI on every push to this repo.

Jasmine tests are run in a browser using karma. To run them locally:

npm run test-jasmine

Image pixel comparison tests are run in a docker container. For more information on how to run them locally, please refer to image test README.

Running the test locally outputs the generated png images in build/test_images/ and the png diffs in build/test_images_diff/ (two git-ignored directories).

To view the image pixel comparison test results, run

npm run start-image_viewer

which shows the baseline image, the generated image, the diff and the json mocks of test cases that failed.

To view the results of a run on CircleCI, download the build/test_images/ and build/test_images_diff/ artifacts into your local repo and then run npm run start-image_viewer.

Repo organization

  • Distributed files are in dist/
  • CommonJS require-able modules are in lib/
  • Sources files are in src/, including the index
  • Build and repo management scripts are in tasks/
  • All tasks can be run using npm run-script
  • Tests are test/, they are partitioned into image and jasmine tests
  • Test dashboard and image viewer code is in devtools/
  • Non-distributed, built files are in build/ (most files in here are git-ignored, the css and font built files are exceptions)

Coding style

Check if ok, with npm run lint

  • See eslintrc and the eslint list of rules for more details.
  • Rules listed in the eslintrc file with the ignore flag 0 are the recommended rules for new code added.