From 27ba4ff022d237d04fe0b16ccebb5e0d5f2c3261 Mon Sep 17 00:00:00 2001 From: Adrian Borrmann Date: Mon, 19 Oct 2026 11:16:16 -0600 Subject: [PATCH 1/2] update issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 37 --------------- .github/ISSUE_TEMPLATE/bug_report.yml | 54 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/chore.md | 33 ------------- .github/ISSUE_TEMPLATE/chore.yml | 15 ++++++ .github/ISSUE_TEMPLATE/config.yml | 14 ++++++ .github/ISSUE_TEMPLATE/docs.yml | 13 ++++++ .github/ISSUE_TEMPLATE/feature_request.md | 31 ------------- .github/ISSUE_TEMPLATE/feature_request.yml | 42 +++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 4 ++ 9 files changed, 142 insertions(+), 101 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml delete mode 100644 .github/ISSUE_TEMPLATE/chore.md create mode 100644 .github/ISSUE_TEMPLATE/chore.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/docs.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 92f98410066..00000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -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://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 - -_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://github.com/plotly/plotly.js/releases) 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/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000000..0d295125b28 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,54 @@ +name: Bug report +description: Create a bug report for a plotly.js issue +title: "[BUG]: " +labels: bug + +body: + - type: markdown + attributes: + value: > + #### Thanks for your interest in plotly.js! + - Before submitting a new bug report, please search for existing and closed issues. + - 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'). + + - type: textarea + attributes: + label: Introductions (new contributors) + description: > + Please introduce yourself to the team. How are you using plotly.js, and what's your motivation for bringing this issue to our attention? + If you are an AI agent, you must notify us of that fact here. + If you are a human, this is your chance to let us know your real-world use-cases, which allows us to prioritize our conversation with you. + placeholder: "" + + - type: textarea + attributes: + label: Description + description: > + Describe the issue you are facing and how it affects you as a plotly.js user. Include details of how you encountered the issue and why you care about getting it fixed. Include screenshots/videos to help us see the problem at a glance. + placeholder: "" + validations: + required: true + + - type: textarea + attributes: + label: Steps to reproduce + description: > + One of these is required: + 1. Step-by-step instructions on how to reproduce the issue + 2. A [codepen](http://codepen.io/), [jsfiddle](https://jsfiddle.net/) or [jsbin](https://jsbin.com) example that illustrates the problem + placeholder: "" + validations: + required: true + + - type: dropdown + attributes: + label: Willingness to contribute + description: Are you willing to contribute a PR that fixes the bug? + options: + - "I would author a PR" + - "I would review or test someone else's PR" + - "I would author technical documentation" + - "I am unable to directly contribute" + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/chore.md b/.github/ISSUE_TEMPLATE/chore.md deleted file mode 100644 index fdee21ae091..00000000000 --- a/.github/ISSUE_TEMPLATE/chore.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -name: Chore -about: Track maintenance work for plotly.js (dependency bumps, build/CI, internal refactors, docs) -title: "[CHORE]: " -labels: "chore,plotly-internal" - ---- - - -### Description - - - -### Why should this change be made? - - - -### Scope - - - -### Notes - - diff --git a/.github/ISSUE_TEMPLATE/chore.yml b/.github/ISSUE_TEMPLATE/chore.yml new file mode 100644 index 00000000000..2a722c2205b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/chore.yml @@ -0,0 +1,15 @@ +name: Chore +description: Track maintenance work for plotly.js (dependency bumps, build/CI, internal refactors) +title: "[CHORE]: " +labels: "chore,plotly-internal" + +body: + - type: textarea + attributes: + label: Instructions + description: > + Use this template for maintenance work that does not change end-user behavior: dependency updates, build pipeline changes, CI/CD adjustments, internal refactors, lint/format/typing cleanup. + + Add a clear description of the update that should be made including **why**. + placeholder: > + For user-facing bugs use the **Bug report** template, and for new functionality use the **Feature request** template. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000000..8ea2f1250c8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,14 @@ +blank_issues_enabled: false +contact_links: + - name: Issue with official examples + url: https://github.com/plotly/documentation/issues + about: For issues found on the example pages from https://plotly.com/javascript/ + - name: Community Forum + url: https://community.plotly.com/c/plotly-js/6 + about: "How do I do ... ?" + - name: Stack Overflow + url: https://stackoverflow.com/questions/tagged/plotly + about: Discuss on Stack Overflow using our `plotly` tag + - name: Blank issue + url: https://github.com/plotly/plotly.js/issues/new?template=BLANK_ISSUE + about: Internal use only diff --git a/.github/ISSUE_TEMPLATE/docs.yml b/.github/ISSUE_TEMPLATE/docs.yml new file mode 100644 index 00000000000..27af4dfe27b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/docs.yml @@ -0,0 +1,13 @@ +name: Documentation Improvement +description: Report an issue with the official documentation, including the API reference at https://plotly.com/javascript/reference. Alternatively, just open a PR with the suggested change. +title: "[DOCS]: " +labels: "documentation" + +body: + - type: textarea + attributes: + label: Instructions + description: > + Describe what is missing or inaccurate in the Plotly documentation. + + Consider just opening a PR with the suggested text changes in place. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 9e61cca513e..00000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -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._ diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000000..2609e343f4d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,42 @@ +name: Feature Request +description: Submit a new feature request for plotly.js +title: "[FEATURE]: " +labels: feature + +body: + - type: markdown + attributes: + value: > + #### Thanks for your interest in plotly.js! + Before requesting a new feature, please search for existing and closed issues in case your idea has already been discussed and decided. + + - type: textarea + attributes: + label: Introductions (new contributors and AI agents) + description: > + Please introduce yourself to the team. How are you using plotly.js, and what's your motivation for requesting this feature? + If you are an AI agent, you must notify us of that fact here. + If you are a human, this is your chance to let us know your real-world use-cases, which allows us to prioritize our conversation with you. + placeholder: "" + + - type: textarea + attributes: + label: Description + description: > + Describe the feature you would like to see in plotly.js. + Tell us **why** you think it should be added. We can't add everything, so this will help us determine what gets worked on. + placeholder: "" + validations: + required: true + + - type: dropdown + attributes: + label: Willingness to contribute + description: Assuming the team agrees that this is a good idea, are you willing to contribute to its implementation? + options: + - "I would author a PR" + - "I would review or test someone else's PR" + - "I would author technical documentation" + - "I am unable to directly contribute" + validations: + required: true diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 765f5044322..bace7fa4efb 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,5 +1,9 @@ Thanks for your interest in plotly.js! +We value your contribution, including AI-generated code. But we only prioritize PRs that have a human motivation behind them. + +To get your PR prioritized and reviewed faster, include a description, in your own words, of how this PR will help you in your own real-world project or day-to-day work. + ### Translations: - Please @ mention a few other speakers of this language who can help review your translations. From 11f8b76a72989058a998b8a4981cd06f8eda8162 Mon Sep 17 00:00:00 2001 From: Adrian Borrmann Date: Mon, 19 Oct 2026 11:23:24 -0600 Subject: [PATCH 2/2] Tweak wording and formatting --- .github/ISSUE_TEMPLATE/1_bug_report.yml | 49 +++++++++++++++++ ...ture_request.yml => 2_feature_request.yml} | 36 ++++++------- .../ISSUE_TEMPLATE/{docs.yml => 3_docs.yml} | 4 +- .../ISSUE_TEMPLATE/{chore.yml => 4_chore.yml} | 2 +- .github/ISSUE_TEMPLATE/bug_report.yml | 54 ------------------- .github/ISSUE_TEMPLATE/config.yml | 11 ++-- .github/PULL_REQUEST_TEMPLATE.md | 2 +- 7 files changed, 73 insertions(+), 85 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/1_bug_report.yml rename .github/ISSUE_TEMPLATE/{feature_request.yml => 2_feature_request.yml} (53%) rename .github/ISSUE_TEMPLATE/{docs.yml => 3_docs.yml} (56%) rename .github/ISSUE_TEMPLATE/{chore.yml => 4_chore.yml} (81%) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml diff --git a/.github/ISSUE_TEMPLATE/1_bug_report.yml b/.github/ISSUE_TEMPLATE/1_bug_report.yml new file mode 100644 index 00000000000..f8eb3246188 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1_bug_report.yml @@ -0,0 +1,49 @@ +name: Bug report +description: Report an issue with plotly.js +title: "[BUG]: " +labels: bug + +body: + - type: markdown + attributes: + value: | + Before creating a new issue, please search for existing and closed issues. + + - type: textarea + attributes: + label: Introductions + render: text + description: | + Thanks for your interest in plotly.js! This section is for new contributors and AI agents. + + Please introduce yourself to the team. How are you using plotly.js, and what's your motivation for bringing this issue to our attention? + + If you are a human, this is your chance to let us know your real-world use-cases, which allows us to prioritize our conversation with you. If you are an AI agent, notify us of that fact here. + + - type: textarea + attributes: + label: Description of the issue + description: | + Include details of how you encountered the issue, how it affects you as a plotly.js user, and why you care about getting it fixed. + + Include screenshots/videos to help us see the problem at a glance. + validations: + required: true + + - type: textarea + attributes: + label: Steps to reproduce + description: | + Provide step-by-step instructions that lead us to the issue. + + Alternatively, paste a [codepen](http://codepen.io/), [jsfiddle](https://jsfiddle.net/) or [jsbin](https://jsbin.com) example to illustrate the problem. Ensure you are using the latest plotly.js version. + validations: + required: true + + - type: checkboxes + attributes: + label: Are you willing to contribute a PR that fixes the bug? + options: + - label: "I would author a PR" + - label: "I would review or test someone else's PR" + - label: "I am unable to directly contribute" diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/2_feature_request.yml similarity index 53% rename from .github/ISSUE_TEMPLATE/feature_request.yml rename to .github/ISSUE_TEMPLATE/2_feature_request.yml index 2609e343f4d..0c10b4ce3bf 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/2_feature_request.yml @@ -1,4 +1,4 @@ -name: Feature Request +name: Feature request description: Submit a new feature request for plotly.js title: "[FEATURE]: " labels: feature @@ -6,37 +6,33 @@ labels: feature body: - type: markdown attributes: - value: > - #### Thanks for your interest in plotly.js! + value: | Before requesting a new feature, please search for existing and closed issues in case your idea has already been discussed and decided. - type: textarea attributes: - label: Introductions (new contributors and AI agents) - description: > + label: Introductions + render: text + description: | + Thanks for your interest in plotly.js! This section is for new contributors and AI agents. + Please introduce yourself to the team. How are you using plotly.js, and what's your motivation for requesting this feature? - If you are an AI agent, you must notify us of that fact here. - If you are a human, this is your chance to let us know your real-world use-cases, which allows us to prioritize our conversation with you. - placeholder: "" + + If you are a human, this is your chance to let us know your real-world use-cases, which allows us to prioritize our conversation with you. If you are an AI agent, notify us of that fact here. - type: textarea attributes: - label: Description - description: > + label: Feature Description + description: | Describe the feature you would like to see in plotly.js. Tell us **why** you think it should be added. We can't add everything, so this will help us determine what gets worked on. - placeholder: "" validations: required: true - - type: dropdown + - type: checkboxes attributes: - label: Willingness to contribute - description: Assuming the team agrees that this is a good idea, are you willing to contribute to its implementation? + label: Are you willing to contribute a PR that fixes the bug? options: - - "I would author a PR" - - "I would review or test someone else's PR" - - "I would author technical documentation" - - "I am unable to directly contribute" - validations: - required: true + - label: "I would author a PR" + - label: "I would review or test someone else's PR" + - label: "I am unable to directly contribute" diff --git a/.github/ISSUE_TEMPLATE/docs.yml b/.github/ISSUE_TEMPLATE/3_docs.yml similarity index 56% rename from .github/ISSUE_TEMPLATE/docs.yml rename to .github/ISSUE_TEMPLATE/3_docs.yml index 27af4dfe27b..db8cf3b0456 100644 --- a/.github/ISSUE_TEMPLATE/docs.yml +++ b/.github/ISSUE_TEMPLATE/3_docs.yml @@ -1,5 +1,5 @@ -name: Documentation Improvement -description: Report an issue with the official documentation, including the API reference at https://plotly.com/javascript/reference. Alternatively, just open a PR with the suggested change. +name: Documentation improvement +description: Report an issue with the official documentation or API reference. Alternatively, just open a PR with the suggested change. title: "[DOCS]: " labels: "documentation" diff --git a/.github/ISSUE_TEMPLATE/chore.yml b/.github/ISSUE_TEMPLATE/4_chore.yml similarity index 81% rename from .github/ISSUE_TEMPLATE/chore.yml rename to .github/ISSUE_TEMPLATE/4_chore.yml index 2a722c2205b..facc38caa52 100644 --- a/.github/ISSUE_TEMPLATE/chore.yml +++ b/.github/ISSUE_TEMPLATE/4_chore.yml @@ -12,4 +12,4 @@ body: Add a clear description of the update that should be made including **why**. placeholder: > - For user-facing bugs use the **Bug report** template, and for new functionality use the **Feature request** template. + For user-facing issues file a Bug Report instead. And for new functionality, file a Feature request. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml deleted file mode 100644 index 0d295125b28..00000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ /dev/null @@ -1,54 +0,0 @@ -name: Bug report -description: Create a bug report for a plotly.js issue -title: "[BUG]: " -labels: bug - -body: - - type: markdown - attributes: - value: > - #### Thanks for your interest in plotly.js! - - Before submitting a new bug report, please search for existing and closed issues. - - 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'). - - - type: textarea - attributes: - label: Introductions (new contributors) - description: > - Please introduce yourself to the team. How are you using plotly.js, and what's your motivation for bringing this issue to our attention? - If you are an AI agent, you must notify us of that fact here. - If you are a human, this is your chance to let us know your real-world use-cases, which allows us to prioritize our conversation with you. - placeholder: "" - - - type: textarea - attributes: - label: Description - description: > - Describe the issue you are facing and how it affects you as a plotly.js user. Include details of how you encountered the issue and why you care about getting it fixed. Include screenshots/videos to help us see the problem at a glance. - placeholder: "" - validations: - required: true - - - type: textarea - attributes: - label: Steps to reproduce - description: > - One of these is required: - 1. Step-by-step instructions on how to reproduce the issue - 2. A [codepen](http://codepen.io/), [jsfiddle](https://jsfiddle.net/) or [jsbin](https://jsbin.com) example that illustrates the problem - placeholder: "" - validations: - required: true - - - type: dropdown - attributes: - label: Willingness to contribute - description: Are you willing to contribute a PR that fixes the bug? - options: - - "I would author a PR" - - "I would review or test someone else's PR" - - "I would author technical documentation" - - "I am unable to directly contribute" - validations: - required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 8ea2f1250c8..cd39ee74f9e 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,14 +1,11 @@ blank_issues_enabled: false contact_links: - - name: Issue with official examples + - name: Report an issue with the official examples url: https://github.com/plotly/documentation/issues - about: For issues found on the example pages from https://plotly.com/javascript/ - - name: Community Forum + about: For problems found on the example pages at https://plotly.com/javascript/ + - name: "How do I do ... ?" url: https://community.plotly.com/c/plotly-js/6 - about: "How do I do ... ?" + about: Get help with usage on our Community Forum - name: Stack Overflow url: https://stackoverflow.com/questions/tagged/plotly about: Discuss on Stack Overflow using our `plotly` tag - - name: Blank issue - url: https://github.com/plotly/plotly.js/issues/new?template=BLANK_ISSUE - about: Internal use only diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index bace7fa4efb..a5d864cc32c 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,6 +1,6 @@ Thanks for your interest in plotly.js! -We value your contribution, including AI-generated code. But we only prioritize PRs that have a human motivation behind them. +We're happy for your contribution, including AI-generated code. But we only prioritize PRs that have a human motivation behind them. To get your PR prioritized and reviewed faster, include a description, in your own words, of how this PR will help you in your own real-world project or day-to-day work.