From 1ef8c37c3aeaa67d6710e902b92bb3477cd40212 Mon Sep 17 00:00:00 2001 From: Artem Yurchenko Date: Thu, 3 Apr 2025 12:11:04 +0200 Subject: [PATCH] Implement better template for feature request issue (#1132) This PR implements a new feature request template with a few UX/UI improvements. Key changes: - Use of GitHub forms. - Provide note info for a submitter about feature request submitting rules. - Adds a few handy fields like "Describe the feature" or "Use Case" Overall, with a template like this feature requests will be more structured and meaningful. --- .github/ISSUE_TEMPLATE/feature-request.md | 11 ----- .github/ISSUE_TEMPLATE/feature-request.yml | 54 ++++++++++++++++++++++ 2 files changed, 54 insertions(+), 11 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/feature-request.md create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md deleted file mode 100644 index 3dd410fd..00000000 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -name: Feature Request -about: Suggest an idea to help make Khoj a better tool -title: "[IDEA]" -labels: "upgrade" -assignees: '' - ---- - -## Describe the feature you'd like -A clear and concise description of what you want to happen. Include any relevant links or screenshots or inspiration. diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 00000000..5820799f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,54 @@ +name: "🙋 Feature Request" +description: "Use this template to request new feature or suggest an idea for Khoj" +labels: ["upgrade"] +body: + - type: "markdown" + attributes: + value: | + > [!IMPORTANT] + > To save time for both you and us, try follow these guidelines before submitting a feature request: + > 1. Check if there is an existing feature request that is similar to your on our Github. + > 2. We encourage you to first discuss your idea on a [Github discussion](https://github.com/khoj-ai/khoj/discussions/categories/ideas) or the **#ideas** channel of our [Discord server](https://discord.gg/b6gUdpKr). + > This step helps in understanding the new feature and determining if it's can be implemented at all. + Only proceed with this report if your idea was approved after the GitHub/Discord discussion. + + - type: "textarea" + id: "description" + attributes: + label: "Describe the feature" + description: "A clear and concise description of the feature you are proposing." + validations: + required: true + + - type: "textarea" + id: "use-case" + attributes: + label: "Use Case" + description: "Why do you need this feature? Provide real world use cases, the more the better." + validations: + required: true + + - type: "textarea" + id: "solution" + attributes: + label: "Proposed Solution" + description: "Suggest how to implement the new feature. Please include prototype/sketch/reference implementation." + validations: + required: false + + - type: "textarea" + id: "additional_info" + attributes: + label: "Additional Information" + description: "Any additional information you would like to provide - links, screenshots, etc." + validations: + required: false + + - type: "input" + id: "discussion_link" + attributes: + label: "Link to Discord or Github discussion" + description: "Provide a link to the first message of feature request's discussion on Discord or Github.\n + This will help to keep history of why this feature request exists." + validations: + required: false \ No newline at end of file