Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add measures to reduce duplicate issues #6184

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from

Conversation

Robbbo-T
Copy link

@Robbbo-T Robbbo-T commented Jan 13, 2025

Related to #4227


For more details, open the Copilot Workspace session.

Copy link

changeset-bot bot commented Jan 13, 2025

⚠️ No Changeset found

Latest commit: d8b67c5

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

netlify bot commented Jan 13, 2025

Deploy Preview for mermaid-js ready!

Name Link
🔨 Latest commit d8b67c5
🔍 Latest deploy log https://app.netlify.com/sites/mermaid-js/deploys/678530692357570008226419
😎 Deploy Preview https://deploy-preview-6184--mermaid-js.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

pkg-pr-new bot commented Jan 13, 2025

Open in Stackblitz

npm i https://pkg.pr.new/mermaid-js/mermaid@6184
npm i https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/layout-elk@6184
npm i https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/mermaid-zenuml@6184
npm i https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/parser@6184

commit: d8b67c5

Copy link

codecov bot commented Jan 13, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 4.47%. Comparing base (bc2cc61) to head (d8b67c5).

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##           develop   #6184   +/-   ##
=======================================
  Coverage     4.47%   4.47%           
=======================================
  Files          383     383           
  Lines        54142   54142           
  Branches       596     596           
=======================================
  Hits          2425    2425           
  Misses       51717   51717           
Flag Coverage Δ
unit 4.47% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

* **bug_report.yml**
  - Add a mandatory checkbox for users to confirm they have searched for existing issues
  - Add specific questions and prompts to guide users to provide detailed information
  - Add a checklist reminding users to search for existing issues before creating a new one

* **config.yml**
  - Add a more prominent reminder to search through existing issues before creating a new one

* **diagram_proposal.yml, syntax_proposal.yml, theme_proposal.yml**
  - Add specific questions and prompts to guide users to provide detailed information
  - Add a checklist reminding users to search for existing issues before creating a new one
Comment on lines +61 to +67
- type: checkboxes
attributes:
label: Confirmation
description: Please confirm the following before submitting your issue.
options:
- label: I have searched for existing issues
required: true
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- type: checkboxes
attributes:
label: Confirmation
description: Please confirm the following before submitting your issue.
options:
- label: I have searched for existing issues
required: true
- type: checkboxes
attributes:
label: Confirmation
description: Please confirm the following before submitting your issue.
options:
- label: I have searched for existing proposals
required: true

Please move this to the top of the questions, so people won't waste time filling out the rest.

Comment on lines +1 to +19
# Number of days of inactivity before an issue becomes stale
daysUntilStale: 30
# Number of days of inactivity before a stale issue is closed
daysUntilClose: 7
# Issues with these labels will never be considered stale
exemptLabels:
- Retained
# Label to use when marking an issue as stale
staleLabel: Inactive
# Comment to post when marking an issue as stale. Set to `false` to disable
markComment: >
This issue has been automatically marked as stale because it has not had
recent activity. It will be closed if no further activity occurs. Thank you
for your contributions.
If you are still interested in this issue and it is still relevant you can comment to revive it.
# Comment to post when closing a stale issue. Set to `false` to disable
closeComment: >
This issue has been been automatically closed due to a lack of activity.
This is done to maintain a clean list of issues that the community is interested in developing.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We're not planning on using stalebot to close issues, so you can remove this file.

state: 'open',
labels: 'Status: Triage'
});
const duplicate = issues.find(issue => issue.title === context.payload.issue.title);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I love the idea of finding duplicates automatically, we can move this out into a separate PR, with a more powerful script, which would address some issues of this approach.

  • The chance of exact matches in title would be very low.
  • listForRepo would only return 30 items without pagination.
  • Searching for labels: 'Status: Triage' would only give a subset of issues, there might be open/closed issues for the same request.

Comment on lines +74 to +87
- type: checkboxes
attributes:
label: Confirmation
description: Please confirm the following before submitting your issue.
options:
- label: I have searched for existing issues
required: true
- type: checkboxes
attributes:
label: Confirmation
description: Please confirm the following before submitting your issue.
options:
- label: I have searched for existing issues
required: true
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Duplicated

Comment on lines +88 to +120
- type: textarea
attributes:
label: Environment
description: Provide details about your environment, such as operating system, browser, and version.
placeholder: |-
- Operating System: [Windows, macOS, Linux]
- Browser and Version: [Chrome, Edge, Firefox]
- type: textarea
attributes:
label: Expected Behavior
description: Describe what you expected to happen.
placeholder: I expected ...
- type: textarea
attributes:
label: Actual Behavior
description: Describe what actually happened.
placeholder: Instead, I saw ...
- type: textarea
attributes:
label: Additional Information
description: Provide any additional information that may help us understand the issue.
placeholder: Any other relevant information...
- type: checkboxes
attributes:
label: Confirmation
description: Please confirm the following before submitting your issue.
options:
- label: I have searched for existing issues
required: true
- label: I have checked the [Live Editor - Develop](https://develop.git.mermaid.live) to see if the issue is already fixed
required: true
- label: I have provided detailed information about the issue
required: true
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All this is already asked in the questions above.

Is this an AI PR? :(

Comment on lines +35 to +45
- type: textarea
attributes:
label: Use Cases
description: If applicable, give some use cases for where this syntax would be useful.
placeholder: The Syntax could be used for ...
- type: textarea
attributes:
label: Syntax
description: |-
If possible, include a syntax which could be used to write the diagram.
Try to add one or two examples of valid use-cases here.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- type: textarea
attributes:
label: Use Cases
description: If applicable, give some use cases for where this syntax would be useful.
placeholder: The Syntax could be used for ...
- type: textarea
attributes:
label: Syntax
description: |-
If possible, include a syntax which could be used to write the diagram.
Try to add one or two examples of valid use-cases here.

Comment on lines +43 to +52
- type: textarea
attributes:
label: Use Cases
description: If applicable, give some use cases for where this theme would be useful.
placeholder: The theme could be used for ...
- type: textarea
attributes:
label: Additional Information
description: Provide any additional information that may help us understand the theme proposal.
placeholder: Any other relevant information...
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- type: textarea
attributes:
label: Use Cases
description: If applicable, give some use cases for where this theme would be useful.
placeholder: The theme could be used for ...
- type: textarea
attributes:
label: Additional Information
description: Provide any additional information that may help us understand the theme proposal.
placeholder: Any other relevant information...

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not planning on using stalebot, this file can be removed.

@sidharthv96 sidharthv96 mentioned this pull request Jan 27, 2025
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants