whatsapp-web.js/.github/ISSUE_TEMPLATE/bug_report.yml
alechkos 1e03ca6828
chore: update issue templates (#3298)
* chore: update issue template for more clarity

* chore: update feature request template for more clarity

* chore: update pr template for more clarity
2024-09-30 20:34:39 +03:00

140 lines
No EOL
5 KiB
YAML

name: '🐛 Bug Report'
description: Create a report to help us improve
labels: bug
body:
- type: markdown
attributes:
value: |
### Thank you for reporting an issue.
### Here are some important points to consider before submitting a new bug or issue:
- Please report only issues related to the `whatsapp-web.js` library.
- Duplicate issues will be closed.
- Any issue opened as a question will be closed.
### If you have any question about how to achieve something and are struggling, please post a question in our [Discord Server](https://discord.gg/wyKybbF) instead.
### Please check the links below to see if you can find a solution there:
- [Open Issues](https://github.com/pedroslopez/whatsapp-web.js/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc)
- [Closed Issues](https://github.com/pedroslopez/whatsapp-web.js/issues?q=is%3Aissue+sort%3Aupdated-desc+is%3Aclosed)
- [Library Documentation](https://docs.wwebjs.dev/)
- [Guide](https://wwebjs.dev/guide)
- [JavaScript Guide](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide)
- [Node.js Documentation](https://nodejs.org/en/docs/)
### The more information you fill in, the better the community can help you.
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists for the bug you encountered.
options:
- label: I have searched the existing issues.
required: true
- type: checkboxes
attributes:
label: Is this a problem caused by your code, or is it specifically because of the library?
description: Please check your code once again to make sure it is correct.
options:
- label: I have double-checked my code carefully.
required: true
- type: textarea
id: description
attributes:
label: Describe the bug.
description: Provide a clear and concise description of the challenge you are running into.
validations:
required: true
- type: textarea
id: expected
attributes:
label: Expected Behavior
description: Provide a clear and concise description of what you expected to happen.
placeholder: |
As a user, I expected ___ behavior, but I am seeing ___
validations:
required: true
- type: textarea
id: steps
attributes:
label: Steps to Reproduce the Bug or Issue
description: Describe the steps we have to take to reproduce the behavior. Additionally, **please include the code snippet you used.** Use [syntax highlighting](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks#syntax-highlighting) for more readability.
placeholder: |
Your steps to reproduce the bug here...
```js
// your code here
```
validations:
required: true
- type: dropdown
id: whatsapp_type
attributes:
label: WhatsApp Account Type
options:
- Standard
- WhatsApp Business
validations:
required: true
- type: input
id: browser_type
attributes:
label: Browser Type
description: What web browser are you using? **Also provide the browser version.**
placeholder: Chromium | Google Chrome | other (provide the type)
validations:
required: true
- type: input
id: os
attributes:
label: Operation System Type
description: What OS are you using? **Also provide its version.**
placeholder: Mac | Windows | Linux | Docker + Ubuntu | other (provide the type)
validations:
required: true
- type: input
id: phone_os
attributes:
label: Phone OS Type
description: What OS are you using on your phone? **Also provide its version.**
placeholder: Android | iOS | other (provide the type)
validations:
required: true
- type: input
id: lib_version
attributes:
label: WhatsApp-Web.js Version
description: What library version are you using? Check it in `package.json` file.
validations:
required: true
- type: input
id: wweb_version
attributes:
label: WhatsApp Web Version
description: What WhatsApp Web version are you using? Run `await client.getWWebVersion()`.
validations:
required: true
- type: input
id: node_version
attributes:
label: Node.js Version
description: What Node.js version are you using? Run `node -v` in your terminal.
validations:
required: true
- type: dropdown
id: auth_type
attributes:
label: Authentication Strategy
description: What authenctication strategy are you using?
options:
- LocalAuth
- RemoteAuth
- NoAuth
validations:
required: true
- type: textarea
id: additional
attributes:
label: Additional Context
description: Add any other context about the problem here.