Contribute
Report an Issue πŸ“’

If you want to report a bug, request a feature, suggest docs improvements, or propose a new integration, you can do that on the MindsDB GitHub issues page.

But before reporting a new issue, please make sure that it is not already there.

​
How to Create an Issue

Here is how to get started when you want to create an issue in the MindsDB repository.

Go to our GitHub issues page and click on the New issue button.

Now you see the available issue types.

Let’s go through all of them one by one.

​
Report a Bug 🐞

Here, we choose Report a bug and click on the Get started button.

Now, it’s time to fill up the form.

  1. It is vital to add a meaningful issue title.

  2. Here, you describe the current behavior. Please note that this field is mandatory. Below you can attach any videos or screenshots of the current behavior.

  3. If you know what the expected behavior should be, you can add it here.

  4. It is helpful for us if you add the steps you followed that led you to the error.

  5. Any links, references, logs, screenshots, etc., are welcome!

Remember, all contributions to our repository should follow the contributing guidelines and code of conduct.

Thank you for reporting a bug! It helps us improve MindsDB for you and future users.

​
Request a Feature πŸš€

Here, we choose Request a feature and click on the Get started button.

Now, it’s time to fill up the form.

  1. It is vital to add a meaningful issue title.

  2. Here, you describe the feature request along with the motivation for the proposed feature. Please note that this field is mandatory. Below you can attach any videos or screenshots.

  3. If you know how the solution should look, you can add it here.

  4. Any links, references, logs, screenshots, etc., are welcome!

Remember, all contributions to our repository should follow the contributing guidelines and code of conduct.

Thank you for submitting a feature request! It helps us improve MindsDB for you and future users.

​
Improve our Docs ✍️

Here, we choose Improve our docs and click on the Get started button.

Now, it’s time to fill up the form.

  1. It is vital to add a meaningful issue title.

  2. Here, you describe what should be added or improved. Please note that this field is mandatory. Below you can attach any videos or screenshots.

  3. Any links, references, logs, screenshots, etc., are welcome!

Remember, all contributions to our repository should follow the contributing guidelines and code of conduct.

Thank you for suggesting docs enhancements! It helps us improve MindsDB for you and future users.

​
Propose a New Integration πŸ§‘β€πŸ”§

Here is how to get started when you want to propose a new integration. Please note it can be a new database integrations or a new machine learning framework.

We choose Propose a new integration and click on the Get started button.

Now, it’s time to fill up the form.

  1. It is vital to add a meaningful issue title.

  2. Please make sure that this integration is not already implemented.

  3. Here, you describe the use case(s) solved by this integration.

  4. Please provide a motivation for your integration proposal.

  5. Get creative and describe the implementation! You can use code, text, diagrams, etc.

  6. Any links, references, logs, screenshots, etc., are welcome!

Remember, all contributions to our repository should follow the contributing guidelines and code of conduct.

Thank you for proposing a new integration! It helps us improve MindsDB for you and future users.

​
Report a Security Vulnerability

Here is how to get started when you want to report a security vulnerability. Please note that such issues are visible only to repository maintainers. Also, you will be credited if the advisory is published.

We choose Report a security vulnerability and click on the Get started button.

Now, it’s time to fill up the form.

  1. It is vital to add a meaningful issue title.

  2. Please follow the instructions to provide the best description.

  3. Here, you can choose one or more affected products along with the versions.

  4. Please assign the severity of the issue. The Calculator feature can help you assess the severity.

  5. Here, you can assign one or more common weakness enumerators (CWE).

Remember, all contributions to our repository should follow the contributing guidelines and code of conduct.

Thank you for reporting a security vulnerability! It helps us improve MindsDB for you and future users.

​
Issue Review

  • Issues are reviewed regularly, usually daily.
  • Depending on the issue type, it will be labeled as Bug or enhancement.
  • Please make sure you respond to our feedback/questions regarding your issue.