From 9302279dd2911e110d8af4e64e7b5b7d3e99a811 Mon Sep 17 00:00:00 2001 From: Mike Farah Date: Wed, 25 Nov 2020 22:22:16 +1100 Subject: [PATCH] updated issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 4 ++-- .github/ISSUE_TEMPLATE/feature_request.md | 12 ++++++++---- 2 files changed, 10 insertions(+), 6 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index f309a7e0..13705f35 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,5 +1,5 @@ --- -name: Bug report +name: Bug report - V3 / V4 about: Create a report to help us improve title: '' labels: bug @@ -14,7 +14,7 @@ version of yq: operating system: **Input Yaml** -Concise yaml document(s) (as simple as possible to show the bug) +Concise yaml document(s) (as simple as possible to show the bug, please keep it to 10 lines or less) data1.yml: ```yaml this: should really work diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 5fcec3bd..91ef8f20 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,5 +1,5 @@ --- -name: Feature request +name: Feature request - V4 about: Suggest an idea for this project title: '' labels: enhancement @@ -7,11 +7,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 [...] +**Please describe your feature request.** +A clear and concise description of what the request is and what it would solve. +Ex. I wish I could use yq to [...] + +Please note that V3 will no longer have any enhancements. **Describe the solution you'd like** If we have data1.yml like: +(please keep to around 10 lines ) ```yaml country: Australia @@ -20,7 +24,7 @@ country: Australia And we run a command: ```bash -yq predictWeather data1.yml +yq eval 'predictWeatherOf(.country)' ``` it could output