diff --git a/CONTRIBUTING.md b/docs/CONTRIBUTING.md similarity index 76% rename from CONTRIBUTING.md rename to docs/CONTRIBUTING.md index 90bb288e..a47efe68 100644 --- a/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -17,7 +17,12 @@ If your issue or contribution pertains directly to the core Ollama technology, p ### 🚨 Reporting Issues -Noticed something off? Have an idea? Check our [Issues tab](https://github.com/ollama-webui/ollama-webui/issues) to see if it's already been reported or suggested. If not, feel free to open a new issue. Include as much detail as possible to help us understand and address your concern efficiently. +Noticed something off? Have an idea? Check our [Issues tab](https://github.com/ollama-webui/ollama-webui/issues) to see if it's already been reported or suggested. If not, feel free to open a new issue. When reporting an issue, please follow our issue templates. These templates are designed to ensure that all necessary details are provided from the start, enabling us to address your concerns more efficiently. + +> [!IMPORTANT] +> - **Template Compliance:** Please be aware that failure to follow the provided issue template, or not providing the requested information at all, will likely result in your issue being closed without further consideration. This approach is critical for maintaining the manageability and integrity of issue tracking. +> +> - **Detail is Key:** To ensure your issue is understood and can be effectively addressed, it's imperative to include comprehensive details. Descriptions should be clear, including steps to reproduce, expected outcomes, and actual results. Lack of sufficient detail may hinder our ability to resolve your issue. ### 🧭 Scope of Support