From 692b04304b1ff6cdfa06000da1df4945ac7273be Mon Sep 17 00:00:00 2001 From: etpinard Date: Tue, 1 Dec 2015 16:09:51 -0500 Subject: [PATCH 1/2] add info about bug reports and issue in general --- CONTRIBUTING.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3b3af500015..1bbfdc506a2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,6 +5,15 @@ Search for existing and closed issues. If your problem or idea is not addressed yet, [please open a new issue](https://github.com/plotly/plotly.js/issues/new). +Bug reports must be accompanied with a reproducible example. We recommend using +[codepen](http://codepen.io/), [jsfiddle](https://jsfiddle.net/) or +[jsbin](https://jsbin.com) to share your example. + +Note that GitHub issues are reserved for bug reports and feature requests only. +Implementation questions should be asked on Stack Overflow (tagged +[`plotly`](https://stackoverflow.com/questions/tagged/plotly)) or on +community.plot.ly (tagged [`plotly-js`](http://community.plot.ly/c/plotly-js)). + ### Development **Prerequisites**: From ce736a89158f19e3b2d1f7d36b8fa3ae148f14ea Mon Sep 17 00:00:00 2001 From: etpinard Date: Tue, 1 Dec 2015 16:10:20 -0500 Subject: [PATCH 2/2] clean up in CONTRIBUTING and README --- CONTRIBUTING.md | 6 +++--- README.md | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1bbfdc506a2..5b9fa4f9775 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -94,12 +94,12 @@ To view the results of a run on CircleCI, download the `build/test_images/` and ### Repo organization - Distributed files are in `dist/` -- Sources files are in `src/`, including the index. -- Build and repo management scripts are in `./tasks/` +- Sources files are in `src/`, including the index +- Build and repo management scripts are in `tasks/` - All tasks can be run using [`npm run-srcript`](https://docs.npmjs.com/cli/run-script) - Tests are `test/`, they are partitioned into `image` and `jasmine` tests - Test dashboard and image viewer code is in `devtools/` -- Non-distributed, git-ignored built files are in `build/` +- Non-distributed, git-ignored built files are in `build/` ### Coding style diff --git a/README.md b/README.md index 4ec1852fcd7..b3d8612b6db 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,7 @@ Read the [Getting started page](https://plot.ly/javascript/getting-started/) for ## Bugs and feature requests -Have a bug or a feature request? Please first read the [issues guidelines](https://github.com/plotly/plotly.js/blob/master/CONTRIBUTING.md). +Have a bug or a feature request? Please first read the [issues guidelines](https://github.com/plotly/plotly.js/blob/master/CONTRIBUTING.md#opening-issues). ## Documentation