Skip to content

Latest commit

 

History

History
71 lines (54 loc) · 2.86 KB

CONTRIBUTING.md

File metadata and controls

71 lines (54 loc) · 2.86 KB
Raw

How to contribute

Pull Requests Guidlines

  • Fork the repository
  • Make changes to the files in src/ not dc.js
  • Add tests to test/. Feel free to create a new file if needed.
  • Run grunt test and fix your patch or other tests as needed
  • Run grunt lint and fix your patch as needed
  • Commit your changes to src/* and test/* but not any build artifacts. (Build artifacts include dc.js, web/docs/, web/js/)
  • Submit a pull request
  • If you merge master or another branch into your patchset, please rebase against master.
  • The DC maintainer team will review and build the artifacts when merging

Testing Notes

We are currently transitioning from vows/jsdom testing to jasmine/PhantomJS. New tests should be written in jasmine (under the spec folder). Once you have run the tests once using grunt test or grunt jasmine, you can debug the tests in your favorite browser by opening web/jasmine-runner.html. You can also run an individual test with grunt jasmine --filter=<part-of-test-filename>

Changing existing vows test cases (under the test folder) to support smaller changes is fine. With vows tests, charts must set .transitionDuration(0) as the dom library used for testing does not support the SVG animation APIs.

Issue Submission Guidlines

  • If you have a problem with your code, please ask your question on stackoverflow.com or the user group
  • For bugs and feature requests submit a github issue
    • Please include the version of DC you are using
    • If you can, please try the latest version of DC on the master branch to see if your issue has already been addressed or is otherwise affected by recent changes.

Merging Pull Requests

for maintainers

Ensure origin looks like this in .git/config. The key element here is the second fetch statement

[remote "origin"]
  url = git@github.com:dc-js/dc.js.git
  fetch = +refs/heads/*:refs/remotes/origin/*
  fetch = +refs/pull/*/head:refs/remotes/origin/pr/*

Run these commands (or their approximation):

# clean master branch
git stash

# double check your aren't going to blow away local commits
git fetch origin
git checkout master
git diff origin/master

# Merge - subsitute the PR number for $PR. Warning this runs git reset --hard, ensure you are ready
grunt merge:$PR

# manually verify the changes and review the demos/examples

# deploy
git push origin master

# review changes before site deployment
git diff origin/gh-pages master:web
grunt web

If needed, the baseline test for the demos can be rebuilt by running grunt web-baseline.