mirror of
https://github.com/StanGirard/quivr.git
synced 2024-11-28 13:42:41 +03:00
50 lines
2.0 KiB
Markdown
50 lines
2.0 KiB
Markdown
|
# Issue template for Quivr - Your Second Brain, Empowered by Generative AI
|
||
|
|
|
||
|
|
## Before you submit an issue 🧐
|
||
|
|
- Make sure you've checked if there are other issues on the same topic.
|
||
|
|
- Be sure to check the documentation and read the README.
|
||
|
|
|
||
|
|
## Submitting a Bug Report 🐛
|
||
|
|
A bug is a demonstrable problem caused by the code in the repository. Good bug reports are extremely helpful!
|
||
|
|
|
||
|
|
Guidelines for bug reports:
|
||
|
|
|
||
|
|
1. **Use the GitHub issue search** — check if the issue has already been reported.
|
||
|
|
|
||
|
|
2. **Check if the issue has been fixed** — try to reproduce it using the latest `master` branch in the repository.
|
||
|
|
|
||
|
|
3. **Isolate the problem** — create a reduced test case and a live example.
|
||
|
|
|
||
|
|
Please try to be as detailed as possible in your report. Include information on
|
||
|
|
|
||
|
|
- Your Operating System
|
||
|
|
- Your Docker and Docker Compose versions
|
||
|
|
- Your Supabase version and setup
|
||
|
|
- Detailed steps to reproduce the issue
|
||
|
|
|
||
|
|
**Example:**
|
||
|
|
|
||
|
|
Short and descriptive example bug report title
|
||
|
|
|
||
|
|
A summary of the issue and the OS environment in which it occurs. If suitable, include the steps required to reproduce the bug.
|
||
|
|
|
||
|
|
This is the first step
|
||
|
|
This is the second step
|
||
|
|
Further steps, etc.
|
||
|
|
Any other information you want to share that is relevant to the issue being reported and iamges if applicable.
|
||
|
|
|
||
|
|
## Submitting a Feature Request 💡
|
||
|
|
|
||
|
|
Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible.
|
||
|
|
|
||
|
|
**Example:**
|
||
|
|
|
||
|
|
Short and descriptive example feature request title
|
||
|
|
|
||
|
|
DESCRIPTION. Provide a brief description of the feature.
|
||
|
|
|
||
|
|
RATIONALE. Explain why this feature should be implemented and how it would be used. Include any relevant use cases and examples.
|
||
|
|
|
||
|
|
IMPLEMENTATION. If possible, provide some details on how you think this could be implemented.
|
||
|
|
|
||
|
|
**Thank you for your contributions! 🙌**
|