From cc29697e1b9d48c99fa51054a213f8ad4c160070 Mon Sep 17 00:00:00 2001 From: Cameron DeCoster Date: Mon, 8 Sep 2025 12:10:57 -0600 Subject: [PATCH 1/4] Don't ignore .github folder --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index 02e1f10c3e7..54c049475cc 100644 --- a/.gitignore +++ b/.gitignore @@ -14,5 +14,6 @@ tags .* !.circleci +!.github/ !.gitignore !.npmignore From b6c87435d62a996c223c68ff10ce50999379a036 Mon Sep 17 00:00:00 2001 From: Cameron DeCoster Date: Mon, 8 Sep 2025 12:11:25 -0600 Subject: [PATCH 2/4] Add new issue template files --- .github/ISSUE_TEMPLATE/bug_report.md | 37 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 31 +++++++++++++++++++ 2 files changed, 68 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000000..aa56faf68ff --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,37 @@ +--- +name: Bug report +about: Create a bug report for a plotly.js issue +title: "[BUG]: " +labels: bug + +--- + +### Instructions (remove this section before submitting report) + +Thanks for your interest in plotly.js! + +- Before submitting a new bug report, please search for existing and closed issues. If your bug is not addressed yet, fill out the sections below and submit a new issue. +- Issues found on the example pages from https://plot.ly/javascript/ should be filed in our [documentation repo](https://github.com/plotly/documentation/issues) with the exception of https://plot.ly/javascript/reference which should be filed here. +- Implementation questions ("How do I do ...?") should be asked on [community.plot.ly](http://community.plot.ly) (tagged `plotly-js`) or on [Stack Overflow](https://stackoverflow.com/questions/tagged/plotly) (tagged `plotly`). +- Comments should add content to the discussions. Approbation comments such as *+1* or *I would like this feature to be implemented as well* will be deleted by the maintainers. Please use [GitHub reactions](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments) instead. + +### Description + +_Add a clear description of the issue that you're having._ + +### Screenshots/Video + +_Add screenshots or a video of the issue._ + +### Steps to reproduce + +_Reports **must** include steps to reproduce the issue. Alternatively, you can use [codepen](http://codepen.io/), [jsfiddle](https://jsfiddle.net/) or [jsbin](https://jsbin.com) to share your example. Please use the [latest un-minified version](https://cdn.plot.ly/plotly-latest.js) of plotly.js in your report unless not applicable._ + +- Go to '...' +- Click on X +- Note the issue with Y + + +### Notes + +_Add info here that doesn't fit in the other sections._ diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000000..9e61cca513e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,31 @@ +--- +name: Feature request +about: Submit a new feature request for plotly.js +title: "[FEATURE]: " +labels: feature + +--- + +### Instructions (remove this section before submitting an issue) + +Thanks for your interest in plotly.js! + +- Before submitting a new feature request, please search for existing and closed requests. If your request is novel, fill out the sections below and submit a new request. +- Comments should add content to the discussions. Approbation comments such as *+1* or *I would like this feature to be implemented as well* will be deleted by the maintainers. Please use [GitHub reactions](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments) instead. + +### Description + +_Add a clear description of the feature that you're requesting._ + + +### Why should this feature be added? + +_Provide an argument for why this feature should be added. We can't add everything, so this will help us determine what gets worked on. Please also consider creating a PR and adding the feature yourself. Help is always appreciated._ + +### Mocks/Designs + +_Please add any mocks or designs you might have for the feature._ + +### Notes + +_Add info here that doesn't fit in the other sections._ From 6e74499587570b3a7ad32b4f288724ec9128ba31 Mon Sep 17 00:00:00 2001 From: Cameron DeCoster Date: Mon, 8 Sep 2025 12:12:04 -0600 Subject: [PATCH 3/4] Remove old issue template file --- .github/ISSUE_TEMPLATE.md | 13 ------------- 1 file changed, 13 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index 046f7ec04d1..00000000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,13 +0,0 @@ -Thanks for your interest in plotly.js! - -Before opening an issue, please 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. Please use the [latest un-minified version](https://cdn.plot.ly/plotly-latest.js) of plotly.js in your report unless not applicable. - -If you don't know JavaScript and still want to help us by reporting a bug, please attach the `"data"` and `"layout"` attributes that describe your graph and updates (if required to detect the bug). One way to retrieve your graph's data and layout attributes is by exporting your graph to [Plotly Cloud](http://plot.ly/). To do so, click on the _Edit in Chart Studio_ mode bar button (the 2nd one from the left by default) and follow these [instructions](https://help.plot.ly/save-share-and-export-in-plotly/), or watch this [screencast](https://community.plot.ly/t/mega-sharing-graphs-with-chart-studio/8869). - -Issues found on the example pages from https://plot.ly/javascript/ should be filed in our [documentation repo](https://github.com/plotly/documentation/issues) with the exception of https://plot.ly/javascript/reference which should be filed here. - -Note that GitHub issues are reserved for bug reports and feature requests only. Implementation questions should be asked on community.plot.ly (tagged [`plotly-js`](http://community.plot.ly/c/plotly-js)) or on Stack Overflow (tagged [`plotly`](https://stackoverflow.com/questions/tagged/plotly)). - -Comments on GitHub issues or pull requests should add content to the discussions. Approbation comments such as *+1* or *I would like this feature to be implemented as well* will be deleted by the maintainers. Please use [GitHub reactions](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments) instead. From 86daf49613e2253ae68dacdf3764170c3f7babf2 Mon Sep 17 00:00:00 2001 From: Cameron DeCoster Date: Thu, 11 Sep 2025 10:35:42 -0600 Subject: [PATCH 4/4] Update old links; clean up language/formatting --- .github/ISSUE_TEMPLATE/bug_report.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index aa56faf68ff..92f98410066 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -11,8 +11,8 @@ labels: bug Thanks for your interest in plotly.js! - Before submitting a new bug report, please search for existing and closed issues. If your bug is not addressed yet, fill out the sections below and submit a new issue. -- Issues found on the example pages from https://plot.ly/javascript/ should be filed in our [documentation repo](https://github.com/plotly/documentation/issues) with the exception of https://plot.ly/javascript/reference which should be filed here. -- Implementation questions ("How do I do ...?") should be asked on [community.plot.ly](http://community.plot.ly) (tagged `plotly-js`) or on [Stack Overflow](https://stackoverflow.com/questions/tagged/plotly) (tagged `plotly`). +- Issues found on the example pages from **https://plotly.com/javascript/** should be filed in our [documentation repo](https://github.com/plotly/documentation/issues) with the exception of **https://plotly.com/javascript/reference** which should be filed here. +- Implementation questions ("How do I do ...?") should be asked on our [Community Forum](https://community.plotly.com/c/plotly-js/6) or on [Stack Overflow](https://stackoverflow.com/questions/tagged/plotly) (tagged 'plotly'). - Comments should add content to the discussions. Approbation comments such as *+1* or *I would like this feature to be implemented as well* will be deleted by the maintainers. Please use [GitHub reactions](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments) instead. ### Description @@ -25,7 +25,7 @@ _Add screenshots or a video of the issue._ ### Steps to reproduce -_Reports **must** include steps to reproduce the issue. Alternatively, you can use [codepen](http://codepen.io/), [jsfiddle](https://jsfiddle.net/) or [jsbin](https://jsbin.com) to share your example. Please use the [latest un-minified version](https://cdn.plot.ly/plotly-latest.js) of plotly.js in your report unless not applicable._ +_Reports **must** include steps to reproduce the issue. Alternatively, you can use [codepen](http://codepen.io/), [jsfiddle](https://jsfiddle.net/) or [jsbin](https://jsbin.com) to share your example. Please use the [latest (un-minified) version](https://github.com/plotly/plotly.js/releases) of plotly.js in your report unless not applicable._ - Go to '...' - Click on X