Contributing

All contributions are welcomed!

Setting Up Development Environment

Bun.js (version 1.2.20 or greater) is used as the testing framework and primary runtime for this project.

Running Tests

To run all tests (skipping the long time-consuming ones):

bun fastest

To run the full test suite:

bun fulltest

Submitting a Pull Request

Create a branch for your changes: git checkout -b feature/your-feature.
Commit your changes with clear messages.
Push to your fork.
Submit a pull request to the main repository.

Reporting Bugs

Open a GitHub issue on the Issues page with a detailed description of the bug.
Please include:

Steps to reproduce
Expected behavior
Actual behavior

Acknowledgment

Thanks to the awesome library Baileys.js for making it possible to use WhatsApp Web for automation purposes. Huge congrats to them; without it, this project wouldn’t be possible.

License

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.