Skip to content

Commit c5c977f

Browse files
Alexandre887Alexandre887
authored
Шаблоны для Issue
1 parent 829a8de commit c5c977f

File tree

5 files changed

+136
-0
lines changed

5 files changed

+136
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: 🛑 Сообщить о баге
2+
description: На сайте учебника что-то неправильно отображается; не работает; работает не так, как нужно
3+
title: "[Баг]: "
4+
labels: ["bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
**Пожалуйста, заполните форму ниже максимально точной информацией.**<br>Правильное описание бага поможет нам намного быстрее решить проблему.
10+
- type: textarea
11+
id: bug-description
12+
attributes:
13+
label: Описание
14+
description: В чём именно заключается баг?
15+
placeholder: |
16+
Например: «в статье [...] неправильно отображается [...]».
17+
validations:
18+
required: true
19+
- type: textarea
20+
id: bug-reproduce
21+
attributes:
22+
label: Как воспроизвести?
23+
description: Что нужно сделать, чтобы воспроизвести этот баг?
24+
placeholder: |
25+
Например: «чтобы воспроизвести баг, нужно: (1) открыть страницу [...] (2) перейти в раздел [...] (3) нажать на [...]».
26+
validations:
27+
required: true
28+
- type: textarea
29+
id: bug-browsers
30+
attributes:
31+
label: Браузер
32+
description: В каком браузере у вас воспроизводится этот баг? Какая версия этого браузера? (можно указать несколько, если тестировали не в одном браузере)
33+
placeholder: |
34+
Например: «у меня воспроизводится этот баг в Chrome 116.0.5845.98»
35+
validations:
36+
required: true

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Наш Discord-сервер
4+
url: https://discord.gg/X8yWNWpTQs
5+
about: Вопросы по JavaScript, HTML, CSS, Node.js, React, TypeScript, Vue.js, Angular, а также «code review» и обсуждение программирования в целом

‎.github/ISSUE_TEMPLATE/tutorial_suggestion.yml‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
name: 📙 Предложить идею по улучшению материала учебника
2+
description: Предложения о добавлении новых разделов/статей в учебник; о переработке существующих статей; о добавлении новых материалов в статьи
3+
title: "[Предложение: учебник]: "
4+
labels: ["suggestion: tutorial"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
## <ins>Не</ins> открывайте Issue в этой категории, если хотите предложить:
10+
* Исправление/изменение кода в какой-либо из статей
11+
* Исправление неточности/устаревшей информации в какой-либо из статей
12+
* Исправление орфографических/пунктуационных/стилистических ошибок в какой-либо из статей
13+
* Добавление задач в какую-либо из статей
14+
15+
...А так же любые другие **небольшие** правки, которые, на ваш взгляд, не требуют обсуждения и могут быть сразу отправлены на рассмотрение.
16+
* «[Как внести правки в учебник?](../blob/master/CONTRIBUTING.md#как-внести-правки-в-учебник)»
17+
## <ins>Открывайте</ins> Issue в этой категории, если хотите предложить:
18+
* Переработку какой-либо статьи (или переработку определенной части статьи)
19+
* Добавление новых разделов в учебник
20+
* Добавление новых статей в учебник
21+
* Добавление нового материала в какую-либо из статей
22+
* ...а так же любые другие **крупные** правки
23+
24+
Перечисленные выше темы требуют предварительного обсуждения с редакторами учебника.
25+
- type: textarea
26+
id: suggestion-description
27+
attributes:
28+
label: Описание
29+
description: Что именно вы хотите предложить?
30+
placeholder: |
31+
Например: «в JavaScript недавно был добавлен [...] — на мой взгляд, было бы неплохо сделать новую статью на эту тему».
32+
validations:
33+
required: true
34+
- type: textarea
35+
id: suggestion-motivation
36+
attributes:
37+
label: Мотивация
38+
description: Почему предлагаемые правки действительно должны быть внесены в учебник?
39+
placeholder: |
40+
Например: «я считаю, что любое представление о [...] без понимания концепции [...] будет недостаточным и неполным, у читателя может сложиться ложное впечатление».
41+
validations:
42+
required: true
43+
- type: dropdown
44+
id: suggestion-question
45+
attributes:
46+
label: Готовы ли вы принять участие в реализации данного предложения?
47+
description: Например, если вы предлагаете добавить новую статью — готовы ли вы заняться её написанием?
48+
options:
49+
- Да, я готов(а) принять участие.
50+
- Нет, я не готов(а) принимать участие. Оставляю эту возможность редакторам учебника.
51+
validations:
52+
required: true

‎.github/ISSUE_TEMPLATE/website_suggestion.yml‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: 🌐 Предложить идею по улучшению веб-сайта
2+
description: Предложения о добавлении нового функционала на сайт учебника; ошибки/опечатки во вкладках «Курсы», «Тесты знаний», «Скринкасты», «о проекте» и т.д; идеи по улучшению курсов
3+
title: "[Предложение: веб-сайт]: "
4+
labels: ["suggestion: website"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Всё, что касается именно <ins>**веб-сайта**</ins>, на котором опубликован учебник — [https://learn.javascript.ru](https://learn.javascript.ru).
10+
11+
В этой категории вы можете:
12+
* Предложить добавление нового функционала на веб-сайт учебника
13+
* Сообщить об ошибках/опечатках во вкладках «Курсы», «Тесты знаний», «Скринкасты», «о проекте» и т.д.
14+
* Предложить идеи по улучшению курсов
15+
- type: textarea
16+
id: suggestion-description
17+
attributes:
18+
label: Описание
19+
description: Что именно вы хотите предложить (или о чём хотите сообщить)?
20+
placeholder: |
21+
Например: «мне кажется, было бы неплохо добавить возможность [...]».
22+
validations:
23+
required: true

‎.github/ISSUE_TEMPLATE/wquestion.yml‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: 📨 Задать вопрос
2+
description: Вопросы по материалу учебника; по веб-сайту; по редактированию учебника
3+
title: "[Вопрос]: "
4+
labels: ["question"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Любые вопросы по материалу учебника; по веб-сайту; по редактированию учебника и т.д.
10+
11+
### <ins>**Мы не консультируем по вопросам о JavaScript здесь.**</ins> Для этих целей есть [Discord-сервер](https://discord.gg/X8yWNWpTQs).
12+
- type: textarea
13+
id: question-description
14+
attributes:
15+
label: Описание
16+
description: Какой у вас вопрос(ы)?
17+
placeholder: |
18+
Например: «почему раздел [...] идёт перед разделом [...], а не после него?».
19+
validations:
20+
required: true

0 commit comments

Comments
 (0)