From e71ebb80684faf63e97c728e360e0d3d55501e22 Mon Sep 17 00:00:00 2001 From: sabaimran Date: Thu, 18 Jan 2024 10:54:05 +0530 Subject: [PATCH] Standardize issue templates and make them easier to use --- .github/ISSUE_TEMPLATE/bug-report.md | 45 +++++++++++++---------- .github/ISSUE_TEMPLATE/feature-request.md | 2 +- 2 files changed, 26 insertions(+), 21 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md index 2684e789..fce50ef5 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -7,31 +7,36 @@ assignees: '' --- -**Describe the bug** -A clear and concise description of what the bug is. +## Describe the bug +A clear and concise description of what the bug is. Please include what you were expecting to happen vs. what actually happened. -**To Reproduce** +## To Reproduce Steps to reproduce the behavior: -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** +## Screenshots If applicable, add screenshots to help explain your problem. -**Desktop:** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] +## Platform +- Server: + - [ ] Cloud-Hosted (https://app.khoj.dev) + - [ ] Self-Hosted Docker + - [ ] Self-Hosted Python package + - [ ] Self-Hosted source code +- Client: + - [ ] Obsidian + - [ ] Emacs + - [ ] Desktop app + - [ ] Web browser + - [ ] WhatsApp +- OS: + - [ ] Windows + - [ ] macOS + - [ ] Linux + - [ ] Android + - [ ] iOS -**Platform**: -- Server [e.g., Cloud-Hosted (https://app.khoj.dev), or Self-Hosted, Docker, or Python package]: -- Client [e.g., Obsidian, Emacs, Desktop app, Web browser]: +### If self-hosted +- Server Version [e.g. 1.0.1]: -**Smartphone:** - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Browser [e.g. stock browser, safari] - -**Additional context** +## Additional context Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md index 5a2ba7c6..3dd410fd 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -7,5 +7,5 @@ assignees: '' --- -**Describe the feature you'd like** +## 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.