From: Dan Vanderkam Date: Thu, 22 Mar 2012 16:12:25 +0000 (-0400) Subject: update changes.html to reflect auto_tests X-Git-Tag: v1.0.0~305 X-Git-Url: https://adrianiainlam.tk/git/?a=commitdiff_plain;h=966ac3fa0de18a7b5ddefe4aba6938d8358ea0cf;p=dygraphs.git update changes.html to reflect auto_tests --- diff --git a/docs/changes.html b/docs/changes.html index b12cc26..6ee7300 100644 --- a/docs/changes.html +++ b/docs/changes.html @@ -4,8 +4,19 @@ Guide to making dygraphs changes @@ -14,8 +25,49 @@

Guide to making dygraphs changes

So you've made a change to dygraphs and would like to contribute it back - to the open source project. Wonderful! This is a step-by-step guide - explaining how to do it.

+ to the open source project. Wonderful!

+ +

This is a step-by-step guide explaining how to do it.

+ +

dygraphs style

+

First of all, please try to follow the style of the existing dygraphs + code. This will make the review process go much more smoothly.

+ +

A few salient points:

+
    +
  1. I try to adhere to Google's + JS style guide and would appreciate it if you try to as well. This + means: +
      +
    • No tabs! Indent using two spaces. +
    • Use camelCase for variable and function names. +
    • Limit lines to 80 characters. +
    + +
  2. Please run 'lint.sh' to see if you've introduced any new violations. + +
  3. If you've added a new feature, add a test for it (in the tests/ + directory) or a gallery entry. + +
  4. If you've added an option, document it in + dygraph-options-reference.js. You'll get lots of warnings if you don't. + +
  5. If you've fixed a bug or added a feature, add an auto_test for + it.
    + This ensures that we won't inadvertently break your feature in the + future. To do this, either add to an existing auto_test in + auto_tests/tests or run "auto_tests/misc/new-test.sh your-test-name" to + create a new one. You can run your auto_test in any browser by visiting + auto_tests/misc/local.html. +
+ +

Sending a Pull Request

+ +

dygraphs is hosted on github, which uses a "pull request" model. They + have a good writeup here. These + instructions discuss dygraphs more specifically.

The list of steps may look a bit daunting, but it's not too bad, especially if you have any familiarity with git or github. If you run into @@ -45,17 +97,9 @@

  • cd into the dygraphs directory and make your changes.
    If you've already got them somewhere else, just copy them over.
    - I try to adhere to Google's - JS style guide and would appreciate it if you try to as well. - -
  • Be a good citizen! - + +
  • Be a good citizen! Make sure your code follows the guidelines + above.
    You'll have to do this before I accept your changes, so you may as well do it now