Merge pull request #736 from danvk/issue-pr-templates

[dygraphs.git] / .github / PULL_REQUEST_TEMPLATE.md

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644 (file)
index 0000000..474eeed
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,14 @@
+Please read the guide to making dygraphs changes:
+http://dygraphs.com/changes.html
+
+Pull Requests will only be accepted if:
+
+- You clearly explain what you're adding and why you believe it's an
+  improvement. For example: "Fixes issue #123".
+- You adhere to the style of the rest of the dygraphs code base.
+- You write an `auto_test` for the code that you're adding.
+
+Be sure to document any new options you add. Also be aware that PRs which add
+options are likely to be rejected. dygraphs already has many options. If you
+can fit your feature into one of those or implement it as a plugin, it will be
+more likely to get merged.