eddy/whatsapp-web.js
Watch
1
0
Fork
You've already forked whatsapp-web.js
 0
Code Issues 1 Pull requests Projects Releases Packages Wiki Activity Actions

chore: cleanup, ci workflows and formatting (#127064)

Browse source 
* ci: setup workflows, dependabot, labeler and commit linting

* docs: update README, community files and issue templates

* chore: configure prettier, editorconfig and format codebase

* chore: restore changes lost during rebase

* docs: adjust url for new logo

* fix: align badges

* chore: resolve conflicts and re-add temp lint
This commit is contained in:
2^1 2026-03-10 00:45:12 +01:00 • committed by GitHub
commit 807efd502d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
5 changed files with 6790 additions and 3547 deletions
Download patch file Download diff file Expand all files Collapse all files

164
.github/ISSUE_TEMPLATE/01-bug_report.yml vendored Normal file
View file

@ -0,0 +1,164 @@
name: Bug Report
description: Report a bug in the library or another package
labels: [bug]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to report a bug! Please check the [issue tracker](https://github.com/wwebjs/wwebjs/issues) before submitting.
> [!CAUTION]
> - **Report only issues related to the `whatsapp-web.js` library!**
> - **Any issue without a clear reproduction will be closed!**
> - **Any issue opened as a question will be closed!**
> - **Duplicate issues will be closed.**
- type: dropdown
id: priority
attributes:
label: Issue Priority
description: Be realistic. Elaborate in the description if needed.
options:
- Low (slightly annoying)
- Medium (should be fixed soon)
- High (immediate attention needed)
default: 0
validations:
required: true
- type: textarea
id: description
attributes:
label: Issue Description
description: Provide a clear and concise description of the problem.
placeholder: |
When I try to send a message, the client disconnects unexpectedly...
validations:
required: true
- type: textarea
id: reproduction_steps
attributes:
label: Steps To Reproduce
description: How can we reproduce this issue?
placeholder: |
1. Do this
2. Do that
...
9. See error
validations:
required: true
- type: textarea
id: code_sample
attributes:
label: Code Sample
description: |
Provide code that reproduces the bug. Ensure it is:
- **Minimal** - Only essential code to show the issue
- **Complete** - Include all dependencies and setup
- **Tested** - Verify it actually triggers the problem
Will be auto-formatted - no backticks needed.
render: typescript
validations:
required: false
- type: dropdown
id: whatsapp_type
attributes:
label: WhatsApp Account Type
description: What type of WhatsApp account are you using?
options:
- Standard
- WhatsApp Business
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: input
id: lib_version
attributes:
label: whatsapp-web.js Version
description: What library version are you using? Check it in `package.json` file.
placeholder: 1.31.0
validations:
required: true
- type: input
id: wweb_version
attributes:
label: WhatsApp Web Version
description: 'What WhatsApp Web version are you using? Use: `await client.getWWebVersion()`'
placeholder: 2.3000.1017054665
validations:
required: true
- type: input
id: browser_type
attributes:
label: Browser Type
description: What web browser are you using?
placeholder: Chromium / Google Chrome / Edge / ...
validations:
required: true
- type: input
id: browser_version
attributes:
label: Browser Version
description: What version of the browser are you using?
placeholder: 120.0.6099.71
validations:
required: true
- type: input
id: computer_os
attributes:
label: Computer OS Version
description: What OS are you using?
placeholder: MacOS 15 / Windows 11 / Ubuntu 24 / ...
validations:
required: true
- type: input
id: phone_os
attributes:
label: Phone OS Version
description: What OS version are you using on your phone?
placeholder: Android 12 / iOS 15.4 / ...
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.
placeholder: 18.16.0
validations:
required: true
- type: checkboxes
id: checklist
attributes:
label: Checklist
options:
- label: '**I use the latest released version of whatsapp-web.js.**'
required: true
- label: I have searched existing issues and confirmed this is not a duplicate.
required: true
- label: I have verified this is a library issue, not a problem with my code.
required: true

55
.github/ISSUE_TEMPLATE/02-feature_request.yml vendored Normal file
View file

@ -0,0 +1,55 @@
name: Feature Request
description: Request a new feature for our applications or packages
labels: [feature request]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to suggest a feature! Please search the [issue tracker](https://github.com/wwebjs/wwebjs/issues) first to avoid duplicates.
> [!CAUTION]
> - **Please submit only feature requests that related to the `whatsapp-web.js` library.**
> - **Any feature request opened as a question will be closed!**
> - **Duplicate issues will be closed.**
- type: textarea
id: description
attributes:
label: Feature summary
description: Briefly describe the problem/use case and desired capability.
placeholder: |
Problem: ...
Benefit: ...
Outcome: ...
validations:
required: true
- type: textarea
id: solution
attributes:
label: Ideal solution or implementation
description: How should this feature work? Include examples like API shape, UX sketches.
placeholder: |
API: client.xyz(...)
Event: client.on('xyz', ...)
Example: const r = await client.xyz()
Compatibility: Breaking changes?
render: markdown
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Alternatives / Additional context
description: Alternatives or workarounds? / More notes/links/screenshots.
- type: checkboxes
id: checklist
attributes:
label: Checklist
options:
- label: I have searched existing issues and confirmed this is not a duplicate.
required: true
- label: This request is within the scope of WhatsApp Web capabilities.
required: false

140
.github/ISSUE_TEMPLATE/bug_report.yml vendored
View file

@ -1,140 +0,0 @@
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.

6
.github/ISSUE_TEMPLATE/config.yml vendored
View file

@ -1,5 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Official WWebJS Discord Server
url: https://discord.gg/H7DqQs4
about: Please ask and answer questions here.
- name: Discord Server
url: https://discord.wwebjs.dev
about: Please ask and answer questions here.

71
.github/ISSUE_TEMPLATE/feature_request.yml vendored
View file

@ -1,71 +0,0 @@
name: 🚀 Feature Request
description: Suggest an idea for this project
labels: enhancement
body:
- type: markdown
attributes:
value: |
### Thank you for suggesting a new idea for this project.
### Here are some important points to consider before continuing:
- Please submit only feature requests that related to the `whatsapp-web.js` library.
- Duplicate feature requests will be closed.
- Any feature request 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 Pull Requests](https://github.com/pedroslopez/whatsapp-web.js/pulls?q=is%3Apr+is%3Aopen+-author%3Aapp%2Fdependabot)
- [Merged Pull Requests](https://github.com/pedroslopez/whatsapp-web.js/pulls?q=is%3Apr+is%3Amerged+-author%3Aapp%2Fdependabot)
- [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/)
- type: checkboxes
attributes:
label: Is the feature you are looking for already implemented in the library?
description: Please check to see if an issue related to this feature request has [already been implemented](https://github.com/pedroslopez/whatsapp-web.js/pulls?q=is%3Apr+is%3Amerged+-author%3Aapp%2Fdependabot).
options:
- label: I have reviewed the implemented features.
required: true
- type: checkboxes
attributes:
label: Is your "solution" already implemented in an opened pull request?
description: Please check the [open pull requests](https://github.com/pedroslopez/whatsapp-web.js/pulls?q=is%3Apr+is%3Aopen+-author%3Aapp%2Fdependabot) to see if there is already an issue related to this feature request.
options:
- label: I have reviewed the existing pull requests.
required: true
- type: textarea
attributes:
label: Is your feature request related to a problem? Please describe.
description: A concise description of the problem you are facing or the motivation behind this feature request.
placeholder: I faced a problem due to...
validations:
required: false
- type: textarea
attributes:
label: Describe the solution you'd like.
description: A concise description of the solution for the issue.
validations:
required: true
- type: textarea
attributes:
label: Describe an alternate solution if you have one.
description: Is there any other approach to solve the problem?
validations:
required: false
- type: textarea
attributes:
label: Additional Context
description: |
Links? Screenshots? References? Anything that will give us more context about what you would like to see!
validations:
required: false