From: Dan Vanderkam <danvdk@gmail.com>
Date: Tue, 21 Oct 2014 05:19:12 +0000 (-0400)
Subject: Add a guide to contributing
X-Git-Url: https://adrianiainlam.tk/git/?a=commitdiff_plain;h=aac6a4fd1ab0998817312e2d2d730249cec88d17;p=dygraphs.git

Add a guide to contributing
---

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..053ba87
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,20 @@
+Filing a bug report? Please include the following:
+1. Link to a page which demonstrates the problem, preferably a jsfiddle (use [this jsfiddle](http://dygraphs.com/fiddle) as a template)
+2. Browser and Operating System that exhibit the problem
+
+It also helps if you include the non-compacted version of the JS on your
+page. For instance, instead of doing this:
+
+```html
+<script type="text/javascript" src="dygraph-combined.js"></script>
+```
+
+do this:
+
+```html
+<script type="text/javascript" src="dygraph-dev.js"></script>
+```
+
+This makes error messages and debugging simpler. The jsfiddle does this automatically.
+
+Sending a Pull Request? See our [guide to making dygraphs contributions](http://dygraphs.com/changes.html).