From: Dan Vanderkam Date: Wed, 16 Mar 2016 16:43:48 +0000 (-0400) Subject: Add new issue and PR templates X-Git-Tag: v2.0.0~26^2 X-Git-Url: https://adrianiainlam.tk/git/?a=commitdiff_plain;h=refs%2Fheads%2Fissue-pr-templates;p=dygraphs.git Add new issue and PR templates --- diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..ee72da0 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,21 @@ +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 + +``` + +do this: + +```html + +``` + +This makes error messages and debugging simpler. The jsfiddle does this automatically. + +Sending a Pull Request? See our [guide to making dygraphs contributions](/DEVELOP.md). diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..75d0c7a --- /dev/null +++ b/.github/ISSUE_TEMPLATE.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 http://dygraphs.com/fiddle as a template) +2. Browser and Operating System that exhibit the problem +3. Version of dygraphs that you're using + +It also helps if you include the non-compacted version of the JS on your +page. For instance, instead of doing this: + +```html + +``` + +do this: + +```html + +``` + +This makes error messages and debugging simpler. The jsfiddle does this automatically. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 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. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index ee72da0..0000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,21 +0,0 @@ -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 - -``` - -do this: - -```html - -``` - -This makes error messages and debugging simpler. The jsfiddle does this automatically. - -Sending a Pull Request? See our [guide to making dygraphs contributions](/DEVELOP.md).