From 8a123da5141edb658f3375329ed1c14915f88a21 Mon Sep 17 00:00:00 2001 From: Paolo Fabio Zaino Date: Thu, 14 Mar 2024 19:25:06 +0000 Subject: [PATCH] Fixed some issues with GitHub Issue Templates --- .github/ISSUE_TEMPLATE/bug_report.md | 27 ++++++++++++----------- .github/ISSUE_TEMPLATE/feature_request.md | 6 +++-- 2 files changed, 18 insertions(+), 15 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index dd84ea78..64b823e0 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -12,10 +12,10 @@ A clear and concise description of what the bug is. **To Reproduce** Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error + +1. Do '...' +2. Do '....' +3. See error **Expected behavior** A clear and concise description of what you expected to happen. @@ -23,16 +23,17 @@ A clear and concise description of what you expected to happen. **Screenshots** If applicable, add screenshots to help explain your problem. -**Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] +**Config.yaml interested portion:** + +```yaml +# Add the portion of the config.yaml that you think is relevant to the issue +``` + +**Rules interested portion:** -**Smartphone (please complete the following information):** - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Browser [e.g. stock browser, safari] - - Version [e.g. 22] +```yaml +# Add the portion of the rules that you think is relevant to the issue +``` **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 bbcbbe7d..66a22cd7 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -8,13 +8,15 @@ assignees: '' --- **Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] +A clear and concise description of what the problem is. +Ex. I'm always frustrated when [...] **Describe the solution you'd like** A clear and concise description of what you want to happen. **Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. +A clear and concise description of any alternative solutions or features +you've considered. **Additional context** Add any other context or screenshots about the feature request here.