AskRobots-Discord is a scalable, plugin-oriented bot for Discord, offering dynamic interactions including AI-powered text conversations with GPT-3.5-Turbo and GPT-4 integration.
Contribution Guidelines
Thank you for your interest in contributing to AskRobots-Discord! This document outlines how to contribute to the project and the guidelines we expect contributors to adhere to. We welcome all types of contributions, including bug fixes, feature improvements, new features, and documentation.
Getting Started
- Fork the repository to your own GitHub account.
- Clone the repository to your local machine.
- Set up the development environment.
Coding Conventions
- Write clean and readable code.
- Follow PEP8 style guidelines for Python code.
- Comment your code adequately to explain your logic and decisions.
- Keep methods and functions small and focused.
Making Changes
- Create a branch for the changes you want to make. The branch name should be descriptive and reflect the changes
- you're making.
- Make commits that are small and logically separate.
- Write meaningful commit messages.
- Make sure your changes do not break any existing functionality.
Submitting Changes
- Push your changes to your forked repository.
- Submit a pull request against the
mainbranch of the original repository. - In the pull request description, explain your changes and why you believe they should be incorporated.
Handling Issues
- Feel free to work on existing issues or create new ones if you encounter any problems or have suggestions for
enhancements.
- When creating a new issue, include as much relevant information as possible. If it's a bug, include steps to
reproduce it.
Community
Please be respectful and considerate of others. We aim to foster a welcoming and inclusive environment for all contributors.
Remember, these are just guidelines. You can tailor them to fit your project's needs. Make sure you provide enough detail for newcomers to understand how to make meaningful contributions.