From dd98dfebab7dbad41f0ab3a0addcc0ac52f48949 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mateusz=20Hordy=C5=84ski?= Date: Tue, 23 Jul 2024 14:09:11 +0200 Subject: [PATCH 1/2] chore: add issue templates --- .github/ISSUE_TEMPLATE/01_feature_request.yml | 31 +++++++++++++++++++ .github/ISSUE_TEMPLATE/02_bug_report.yml | 31 +++++++++++++++++++ 2 files changed, 62 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/01_feature_request.yml create mode 100644 .github/ISSUE_TEMPLATE/02_bug_report.yml diff --git a/.github/ISSUE_TEMPLATE/01_feature_request.yml b/.github/ISSUE_TEMPLATE/01_feature_request.yml new file mode 100644 index 0000000..db4556d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/01_feature_request.yml @@ -0,0 +1,31 @@ +name: 🚀 Feature Request +description: Submit a proposal/request for a new ds-template feature. +title: "feat: " +labels: ["feature"] +body: + - type: markdown + attributes: + value: | + Thanks for contributing to ds-template! + - type: textarea + id: feature-description + attributes: + label: Feature description + description: A clear and concise description of the feature proposal + placeholder: Tell us what you want! + validations: + required: true + - type: textarea + id: feature-motivation + attributes: + label: Motivation + description: A clear and concise description of what the problem is, e.g., I'm always frustrated when [...] + placeholder: Why do you need this feature? + validations: + required: true + - type: textarea + id: feature-context + attributes: + label: Additional context + description: Add any other context or screenshots about the feature request here. + placeholder: Screenshots, code snippets, etc. diff --git a/.github/ISSUE_TEMPLATE/02_bug_report.yml b/.github/ISSUE_TEMPLATE/02_bug_report.yml new file mode 100644 index 0000000..8c43f4e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/02_bug_report.yml @@ -0,0 +1,31 @@ +name: 🐞 Bug Report +description: File a bug report +title: "bug: " +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + - type: textarea + id: what-happened + attributes: + label: What happened? + description: Also tell us, what did you expect to happen? + placeholder: Tell us what you see! + value: "A bug happened!" + validations: + required: true + - type: textarea + id : how-to-reproduce + attributes: + label: How can we reproduce it? + description: Please provide a code snippet to reproduce the bug. + placeholder: import dbally + render: python + - type: textarea + id: logs + attributes: + label: Relevant log output + description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. + render: shell \ No newline at end of file From 9e5980ea50515391a4c85b8d96aa1be6c94194e1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mateusz=20Hordy=C5=84ski?= Date: Tue, 23 Jul 2024 16:19:36 +0200 Subject: [PATCH 2/2] refactor: review comments --- .github/ISSUE_TEMPLATE/01_feature_request.yml | 2 +- .github/ISSUE_TEMPLATE/02_bug_report.yml | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/01_feature_request.yml b/.github/ISSUE_TEMPLATE/01_feature_request.yml index db4556d..84bd423 100644 --- a/.github/ISSUE_TEMPLATE/01_feature_request.yml +++ b/.github/ISSUE_TEMPLATE/01_feature_request.yml @@ -1,6 +1,6 @@ name: 🚀 Feature Request description: Submit a proposal/request for a new ds-template feature. -title: "feat: " +title: "feat: " labels: ["feature"] body: - type: markdown diff --git a/.github/ISSUE_TEMPLATE/02_bug_report.yml b/.github/ISSUE_TEMPLATE/02_bug_report.yml index 8c43f4e..94782e2 100644 --- a/.github/ISSUE_TEMPLATE/02_bug_report.yml +++ b/.github/ISSUE_TEMPLATE/02_bug_report.yml @@ -12,7 +12,7 @@ body: attributes: label: What happened? description: Also tell us, what did you expect to happen? - placeholder: Tell us what you see! + placeholder: XYZ doesn't work as expected... value: "A bug happened!" validations: required: true @@ -20,9 +20,9 @@ body: id : how-to-reproduce attributes: label: How can we reproduce it? - description: Please provide a code snippet to reproduce the bug. - placeholder: import dbally - render: python + description: Please provide steps (commands) that led you to the bug. + placeholder: cookiecutter git@github.com:deepsense-ai/ds-template.git + render: bash - type: textarea id: logs attributes: