Merge https://github.com/kberg/dygraphs
authorDan Vanderkam <danvk@google.com>
Wed, 15 Dec 2010 23:30:29 +0000 (18:30 -0500)
committerDan Vanderkam <danvk@google.com>
Wed, 15 Dec 2010 23:30:29 +0000 (18:30 -0500)
README
docs/changes.html [new file with mode: 0644]
docs/index.html
dygraph-combined.js
gadget.xml

diff --git a/README b/README
index e800692..0fc135d 100644 (file)
--- a/README
+++ b/README
@@ -1,6 +1,7 @@
 dygraphs JavaScript charting library
 Copyright (c) 2006-, Dan Vanderkam.
 
+Documentation: http://dygraphs.com/
 Support: http://groups.google.com/group/dygraphs-users
 Source: http://github.com/danvk/dygraphs
 Issues: http://code.google.com/p/dygraphs/
@@ -19,7 +20,7 @@ Features
 - Compatible with the Google Visualization API
 
 Demo
-For a gallery and documentation, see http://danvk.org/dygraphs/
+For a gallery and documentation, see http://dygraphs.com/
 
 Minimal Example
 <html>
@@ -40,6 +41,10 @@ Minimal Example
 </body>
 </html>
 
+Making Changes
+If you've made a change to dygraphs and would like to contribute it back to the
+community, please follow the guide at http://dygraphs.com/changes.html.
+
 License(s)
 dygraphs uses:
  - rgbcolor.js (Public Domain)
diff --git a/docs/changes.html b/docs/changes.html
new file mode 100644 (file)
index 0000000..e476377
--- /dev/null
@@ -0,0 +1,83 @@
+<html>
+  <head>
+    <title>dygraphs input types</title>
+    <style type="text/css">
+      code { white-space: pre; border: 1px dashed black; display: inline; }
+      pre  { white-space: pre; border: 1px dashed black; }
+      body { max-width: 800px; }
+      ol > li { padding: 5px; }
+    </style>
+  </head>
+  <body>
+    <h2>Guide to making dygraphs changes</h2>
+
+    <p>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.</p>
+
+    <p>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
+    any problems while following the instructions, feel free to contact
+    dygraphs-users.</p>
+
+    <p>Why not just take patches? This process means less work for me (the
+    maintainer) and it also results in your name appearing in the list of
+    dygraphs commits. This lets you take credit for your work.</p>
+
+    <ol>
+      <li>Create an account on <a href="http://github.com">github</a>. This is
+      free, painless and will let you claim credit for your changes.
+
+      <li>Install git. github has a good writeup <a
+        href="http://help.github.com/git-installation-redirect">here</a>.
+
+      <li>Create a fork of the dygraphs repository on github by
+      clicking <a href="https://github.com/danvk/dygraphs">this link</a> and
+      then the "Fork" button.
+
+      <li>You should see a URL along the lines of
+      <code>git@github.com:yourname/dygraphs.git</code><br/>Copy this, open up a
+      terminal and run<br/>
+      <pre>git clone git@github.com:yourname/dygraphs.git</pre> This
+      pulls the dygraphs code down onto your local disk.
+
+      <li>cd into the dygraphs directory and make your changes.<br/>
+      If you've already got them somewhere else, just copy them over.<br/>
+      I try to adhere to Google's <a
+        href="http://google-styleguide.googlecode.com/svn/trunk/javascriptguide.xml">
+        JS style guide</a> and would appreciate it if you try to as well.
+
+      <li>Be a good citizen!
+        <ul>
+          <li>If you've added a new feature, add a test for it (in the tests/
+          directory).
+          <li>If you've added a new option, add it to the list of options on the
+          documentation page (docs/index.html).
+        </ul>
+        You'll have to do this before I accept your changes, so you may as well
+        do it now
+
+      <li>Commit your changes locally: run
+        <pre>git add .
+git commit</pre>
+      Type in a description of your change. This will
+      eventually appear in the dygraphs <a
+        href="https://github.com/danvk/dygraphs/commits/master">commit list</a>.
+
+      <li>Push your changes to github by running <pre>git push</pre>This will
+        send your changes to your forked repository on github.
+
+      <li>Go to your fork of dygraphs on github (i.e.
+      github.com/yourname/dygraphs).<br/>
+      Click the "Pull Request" button.<br/>
+      This will send me an email with a pointer to your changes.
+
+      <li>I'll review your changes and (unless your code is perfect!) give you
+      some feedback. Make these suggested changes in your local git client and
+      re-run "git commit" and "git push" so that I can see them.
+
+      <li>Once your change is ready, I'll pull it into the main dygraphs
+      repository and publish it to the web.
+    </ol>
+  </body>
+</html>
index b9eff54..f8ad937 100644 (file)
@@ -34,6 +34,7 @@
         <li><a href="http://github.com/danvk/dygraphs">Source</a></li>
         <li><a href="http://code.google.com/p/dygraphs/issues/">Issues</a></li>
         <li><a href="http://code.google.com/p/dygraphs/issues/entry">Report Bug</a></li>
+        <li><a href="changes.html">Contribute a change</a></li>
         <li><a href="mailto:dygraphs-users [at] googlegroups.com">Contact</a></li>
       </ul>
 
index d051df1..e6380de 100644 (file)
@@ -1,5 +1,5 @@
 This is not the file you are looking for.
-A reasonably up-to-date version can be found at http://danvk.org/dygraphs/dygraph-combined.js
+A reasonably up-to-date version can be found at http://dygraphs.com/dygraph-combined.js
 
 dygraph-combined.js is a "packed" version of the larger dygraphs JS files. It is
 smaller and loads more quickly, but is harder to debug.
index 3cca999..83a793c 100644 (file)
@@ -6,7 +6,7 @@
       description="Interactive, zoomable chart"
       author="Dan Vanderkam"
       author_email="danvdk@gmail.com"
-      thumbnail="http://danvk.org/dygraphs/thumbnail.png"
+      thumbnail="http://dygraphs.com/thumbnail.png"
       >
       <!-- TODO(danvk): change these -->
       <!--
@@ -39,7 +39,7 @@
 
   <!-- Load the Google common loader, that is later used to load the Visualization API. -->
   <script src="http://www.google.com/jsapi" type="text/javascript"></script>
-  <script src="http://danvk.org/dygraphs/dygraph-combined.js" type="text/javascript"></script>
+  <script src="http://dygraphs.com/dygraph-combined.js" type="text/javascript"></script>
 
   <div id="chartdiv" style="overflow: auto;"><img src="http://www.google.com/ig/images/spinner.gif" /></div>