Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions .github/ISSUE_TEMPLATE/1_bug_report.yml
Original file line number Diff line number Diff line change
@@ -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"
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/2_feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: Feature request
description: Submit a new feature request for plotly.js
title: "[FEATURE]: "
labels: feature

body:
- type: markdown
attributes:
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
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 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: 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.
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"
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE/3_docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
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"

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.
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE/4_chore.yml
Original file line number Diff line number Diff line change
@@ -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 issues file a Bug Report instead. And for new functionality, file a Feature request.
37 changes: 0 additions & 37 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

33 changes: 0 additions & 33 deletions .github/ISSUE_TEMPLATE/chore.md

This file was deleted.

11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
blank_issues_enabled: false
contact_links:
- name: Report an issue with the official examples
url: https://github.com/plotly/documentation/issues
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: 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
31 changes: 0 additions & 31 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

4 changes: 4 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
Thanks for your interest in plotly.js!

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.

### Translations:

- Please @ mention a few other speakers of this language who can help review your translations.
Expand Down
Loading