From 620773c68cba9d87b1fcc220fdc3fa6f6856289a Mon Sep 17 00:00:00 2001 From: Kirill Zolottsev Date: Tue, 27 Dec 2022 18:40:07 +0400 Subject: [PATCH] chore: update bug template --- .github/ISSUE_TEMPLATE/bug.md | 42 ------------------------------ .github/ISSUE_TEMPLATE/bug.yaml | 46 +++++++++++++++++++++++++++++++++ 2 files changed, 46 insertions(+), 42 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug.md create mode 100644 .github/ISSUE_TEMPLATE/bug.yaml diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md deleted file mode 100644 index af9740a..0000000 --- a/.github/ISSUE_TEMPLATE/bug.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -name: Bug -about: Что-то где-то сдохло -labels: bug -assignees: TorinAsakura ---- - -### Описание бага - -1. **@package/name@0.0.0** -2. Затрагиваемые области - -**_Например_**: @package/name@0.1.47 может нарушать работу **[@package/name-next@0.2.23](github.com/org-name/repo-name/backend/name-next/service/index.ts)** - -### Воспроизведение - -Шаги для воспроизведения бага: - -1. Идём туда-то **package/name/src/main.js:561** -2. Выполнить команду или что-то запустить -3. Видим то-то и то-то - -### Ожидаемое поведение - -Чётко и понятно (без "я думал" или "ну, типа и так панятна же…не?") опишите ожидаемое поведение. - -### Материалы - -Прикладываем скриншоты – если ошибка относится к визуальной части и сбор логов не приемлем. - -**_Например:_** -Скриншот логов kubectl или console.log будет абсолютно бесполезным, человек потратит лишнее время на то, чтобы, разобрать мыло которое вы ему прислали (не забывайте, что у всех, как правило, разное разрешение) - -Прикладываем логи — если ошибка относится к системной части и скриншот не поможет в анализе и решении проблемы - -**_Например:_** -Логи при попытке отдебажить графические артефакты или проблему с логикой UI элементов (у кнопки неправильной формы углы) или же когда речь идёт о логике поведения той или иной части приложения (тут лучше вообще делать схемы). - -### Данные окружения - -- OS и версия [например iOS@14.7, Android@6.7.3, Windows@7.1] -- Браузер и версия [например Chrome@64, Safari@13] diff --git a/.github/ISSUE_TEMPLATE/bug.yaml b/.github/ISSUE_TEMPLATE/bug.yaml new file mode 100644 index 0000000..a1ba255 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yaml @@ -0,0 +1,46 @@ +name: Bug +description: Что-то где-то сдохло +labels: ['bug'] +assignees: + - TorinAsakura +body: + - type: textarea + id: bug-description + attributes: + label: Описание бага + validations: + required: true + - type: textarea + id: reproduce + attributes: + label: Воспроизведение + description: 'Шаги для воспроизведения бага:' + placeholder: | + 1. Идём туда-то **package/name/src/main.js:561** + 2. Выполнить команду или что-то запустить + 3. Видим то-то и то-то + validations: + required: true + - type: textarea + id: expected-behavior + attributes: + label: Ожидаемое поведение + placeholder: 'Чётко и понятно (без "я думал" или "ну, типа и так панятна же…не?") опишите ожидаемое поведение.' + validations: + required: true + - type: textarea + id: assets + attributes: + label: Материалы + description: Прикладываем скриншоты – если ошибка относится к визуальной части и сбор логов не приемлем. Прикладываем логи — если ошибка относится к системной части и скриншот не поможет в анализе и решении проблемы + validations: + required: true + - type: textarea + id: env + attributes: + label: Данные окружения + placeholder: | + - OS и версия [например iOS@14.7, Android@6.7.3, Windows@7.1] + - Браузер и версия [например Chrome@64, Safari@13] + validations: + required: true