X-Git-Url: https://adrianiainlam.tk/git/?a=blobdiff_plain;f=docs%2Fchanges.html;h=12a9d528cc6f96954d279b01c72bfc37e9791189;hb=bcc53a778876e9db32d5a58d80e19731ab1a51e4;hp=e476377c4d688cba20c23e91308daa36c7b0019b;hpb=734be391f243fd51632175ede0e2cd1d7404fbea;p=dygraphs.git
diff --git a/docs/changes.html b/docs/changes.html
index e476377..12a9d52 100644
--- a/docs/changes.html
+++ b/docs/changes.html
@@ -1,9 +1,22 @@
+
- dygraphs input types
+
+ Guide to making dygraphs changes
@@ -12,8 +25,57 @@
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:
+
+ - 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.
+
+
+ - Please run 'lint.sh' to see if you've introduced any new violations.
+
+
- If you've added a new feature, add a test for it (in the tests/
+ directory) or a gallery entry.
+
+
- If you've added an option, document it in
+ dygraph-options-reference.js. You'll get lots of warnings if you don't.
+
+
- 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. There are two easy ways to run tests:
+
+ - You can run your auto_test in any browser by visiting
+
auto_tests/misc/local.html
. This allows you to debug your
+ test, or test against a specific browser.
+ - You can run your auto_test on the command-line by running
+
./test.sh
. (It requires installing
+ phantomjs on your computer.)
+
+
+
+ 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
@@ -43,17 +105,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!
-
- - If you've added a new feature, add a test for it (in the tests/
- directory).
-
- If you've added a new option, add it to the list of options on the
- documentation page (docs/index.html).
-
+
+ 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
@@ -79,5 +133,17 @@ git commit
Once your change is ready, I'll pull it into the main dygraphs
repository and publish it to the web.
+
+
+