Add CONTRIBUTION.md

Author: PeterDaveHello

CONTRIBUTION.md

@@ -0,0 +1,141 @@
+# Contributing to ChatALL
+
+Thank you for considering contributing to ChatALL! We welcome contributions from everyone, regardless of your background or experience level. Your contributions help make this project better for everyone.
+
+## Introduction
+
+ChatALL is a project that allows users to chat with multiple AI bots concurrently, helping them discover the best results. Our goal is to provide a seamless and efficient experience for users to interact with various AI bots.
+
+## Reporting Issues
+
+If you find any issues while using ChatALL, please follow these steps to report them:
+
+1. **Check for existing issues**: Before reporting a new issue, please check the [issue tracker](https://github.com/sunner/ChatALL/issues) to see if the issue has already been reported.
+2. **Create a new issue**: If the issue has not been reported, create a new issue using the appropriate [issue template](https://github.com/sunner/ChatALL/issues/new/choose).
+3. **Provide detailed information**: Include as much information as possible, such as the steps to reproduce the issue, your operating system, and any relevant screenshots.
+
+## Submitting Pull Requests
+
+We welcome pull requests from everyone. To submit a pull request, follow these steps:
+
+1. **Fork the repository**: Click the "Fork" button at the top right corner of the repository page to create a copy of the repository in your GitHub account.
+2. **Create a new branch**: Create a new branch for your changes.
+3. **Make your changes**: Make the necessary changes to the codebase.
+4. **Commit your changes**: Commit your changes with a descriptive commit message.
+5. **Push your changes**: Push your changes to your forked repository.
+6. **Create a pull request**: Go to the original repository and click the "New pull request" button. Select your branch and provide a detailed description of your changes.
+
+## Code Style Guidelines
+
+To maintain a consistent codebase, please follow these code style guidelines:
+
+- Use 2 spaces for indentation.
+- Use camelCase for variable and function names.
+- Use PascalCase for class names.
+- Write clear and concise comments to explain your code.
+- Follow the existing code style in the project.
+
+## Encouraging Contributions
+
+We believe that community involvement is crucial for the success of ChatALL. Here are some ways you can contribute:
+
+We believe that community involvement is crucial for the success of ChatALL. Here are some ways you can contribute:
+
+- **Report issues**: If you encounter any issues, please report them using the [issue tracker](https://github.com/sunner/ChatALL/issues).
+- **Submit pull requests**: If you have a fix or improvement, please submit a pull request.
+- **Suggest new features**: If you have an idea for a new feature, please create a new issue to discuss it with the community.
+- **Improve documentation**: If you find any errors or omissions in the documentation, please submit a pull request to improve it.
+
+## Resources for New Contributors
+
+If you are new to contributing to open source projects, here are some resources to help you get started:
+
+If you are new to contributing to open source projects, here are some resources to help you get started:
+
+- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
+- [First Timers Only](https://www.firsttimersonly.com/)
+- [GitHub Docs](https://docs.github.com/en)
+
+## Adding a New AI Bot
+
+If you would like to add a new AI bot to ChatALL, please follow these steps:
+
+If you would like to add a new AI bot to ChatALL, please follow these steps:
+
+1. **Create a new bot file**: In the `src/bots/` directory, create a new file for your bot. You can use the `TemplateBot.js` file as a starting point.
+2. **Implement the `_sendPrompt()` method**: In your new bot file, implement the `_sendPrompt()` method to handle sending prompts to the AI bot.
+3. **Add a reference to your bot**: In the `src/bots/index.js` file, add a reference to your new bot.
+
+### Step-by-Step Guide to Adding a New AI Bot
+
+1. **Create a New Bot File**: Navigate to the `src/bots/` directory and create a new file for your bot. For example, if your bot is named "KnowNothing", create `KnowNothingBot.js`.
+
+   ```javascript
+   // In src/bots/KnowNothingBot.js
+   class KnowNothingBot extends TemplateBot {
+       static _name = "KnowNothingBot"; // Change this to your bot's name
+       static _description = "A bot that knows nothing"; // Change this to your bot's description
+   }
+   ```
+
+4. **Update `src/bots/index.js`**: Add your bot to the `src/bots/index.js` file to ensure it is included in the application. Find the section where other bots are imported and add your bot:
+
+   ```javascript
+   import KnowNothingBot from '@/bots/KnowNothingBot';
+   ```
+
+   Then, add your bot to the appropriate arrays such as `all`, `free`, `paid`, `openSource`, `api`, or `madeInChina` based on its characteristics. For example, if your bot is free and open source, you might add it like this:
+
+   ```javascript
+   const all = [
+     ChatGPT35Bot.getInstance(),
+     ChatGPT4Bot.getInstance(),
+     KnowNothingBot.getInstance(),  // Add your bot here
+     OpenAIAPI35Bot.getInstance(),
+     OpenAIAPI4Bot.getInstance(),
+     ...
+   ];
+
+   export const botTags = {
+     free: [
+       bots.getBotByClassName("BardBot"),
+       bots.getBotByClassName("KnowNothingBot"),  // Add your bot here
+       ...
+     ],
+     openSource: [
+       bots.getBotByClassName("AlpacaBot"),
+       bots.getBotByClassName("KnowNothingBot"),  // Add your bot here
+       ...
+     ],
+     ...
+   };
+
+2. **Implement the `_sendPrompt()` Method**: Implement the `_sendPrompt()` method to handle sending prompts to the AI bot.
+
+   ```javascript
+   async _sendPrompt(prompt) {
+       // Your code to send the prompt to the AI bot
+   }
+   ```
+
+3. **Add a Reference to Your Bot**: In the `src/App.vue` file, add a reference to your new bot.
+
+   ```javascript
+   import KnowNothingBot from './bots/KnowNothingBot';
+   ```
+
+4. **Customize User-Agent (if needed)**: Some websites may restrict access to specific browsers. Set the user-agent in `KnowNothingBot.js` if required.
+
+   ```javascript
+   static _userAgent = "THE_RIGHT_USER_AGENT";
+   ```
+
+5. **Test Your Bot**: Run the application and test your new bot to ensure it works correctly.
+
+   ```bash
+   npm run electron:serve
+   ```
+
+6. **Submit a Pull Request**: Once you have tested your bot and ensured it works correctly, submit a pull request following the steps mentioned in the "How to Submit Pull Requests" section.
+
+Thank you for your contributions! We appreciate your efforts and look forward to your involvement in our community.