Contributing to WBOT

Contributions are welcome! Whether it's a bug report, a feature request, or a code contribution, your help is appreciated.

How to Contribute

We follow the standard GitHub Fork & Pull Request workflow.

1. Fork the repository on GitHub.

2. Create your feature branch from the master branch:

   git checkout -b my-new-feature

3. Make your changes and commit them with a clear message:

   git commit -am 'Add some amazing feature'

4. Push to your forked repository:

   git push origin my-new-feature

5. Create a new Pull Request on the original WBOT repository.

Setting Up a Development Environment

To work on the WBOT source code, you'll need to set up a local development environment.

Prerequisites

• Git
• Node.js (Version 18+ recommended)

Setup Steps

1. Clone your forked repository:

   git clone https://github.com/<YOUR_USERNAME>/WBOT.git
   cd WBOT

2. Install the project dependencies:

   npm install

3. Run the bot for development:

   npm start

   This command executes the main src/index.js file.

Building Binaries

The project uses @yao-pkg/pkg to package the Node.js application into standalone executables for Windows, macOS, and Linux. The configuration for this is in package.json under the pkg key.

To build the binaries yourself, run the following command:

npm run pack

This will generate the executables in the root directory of the project.

Issue Reporting

• Bug Reports: If you find a bug, please create a Bug Report issue and provide as much detail as possible, including steps to reproduce the error.
• Feature Requests: If you have an idea for a new feature, please create a Feature Request issue to discuss it.