Reporting bugs and suggesting improvements
Last updated August 24, 2024
Reporting Bugs and Suggesting Improvements in MindsDB
Your feedback is valuable for improving MindsDB and making it a better experience for everyone. If you encounter a bug or have ideas on how to enhance the platform, you can contribute by reporting issues and suggesting improvements.
Reporting Bugs
- GitHub Issues:
- Use the "Issues" tab on the MindsDB GitHub repository to report bugs you have encountered.
- Clear and Concise Description:
- Provide a clear and concise description of the bug. Include:
- Steps to reproduce the bug: Provide a detailed sequence of steps that lead to the issue.
- Expected behavior: Describe what you expect to happen ideally.
- Actual behavior: Explain what actually happens when the bug occurs.
- Environment details: Specify your operating system, MindsDB version, and any relevant dependencies.
- Attach Relevant Information:
- Include screenshots, error messages, or log files that might assist in understanding the bug.
- Search for Existing Issues:
- Before creating a new issue, search for existing entries. If an issue already exists, add any relevant information or comments to that issue.
Suggesting Improvements
- GitHub Issues:
- Use the "Issues" tab on the MindsDB GitHub repository to propose feature requests or improvements.
- Clearly Define the Improvement:
- Provide a clear, concise, and detailed description of the feature or improvement you are suggesting.
- Explain Motivation:
- Explain why this improvement is beneficial, what problem it solves, and how it enhances the platform's usability or functionality.
- Consider Alternatives:
- If applicable, mention alternative solutions you've considered and why you think the proposed approach is preferable.
Contributing Code
- Fork the Repository:
- Create a fork of the MindsDB GitHub repository to work on your changes.
- Create a Branch:
- Create a new branch for your changes to ensure a clean development workflow.
- Submit a Pull Request:
- Once you have made your changes, submit a pull request to the main repository. This triggers a code review process, allowing other developers to assess and merge your contributions.
- Follow Coding Standards:
- Adhere to the coding style and standards used in the MindsDB repository to ensure consistency and maintainability.
Was this article helpful?