Skip to content

Commit

Permalink
Шаблон заявки на исправление документации
Browse files Browse the repository at this point in the history
  • Loading branch information
alkoleft authored Nov 6, 2024
1 parent 4f59f44 commit 1189797
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/doc-feature.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: '📖 Документация'
description: 'Предложения по доработке документации'
title: '[Doc]: '
labels: ['documentation']
body:
- type: textarea
id: description
attributes:
label: '📖 Описание предложения'
description: 'Общее описание необходимых доработок по документации'
validations:
required: true

- type: input
id: page
attributes:
label: Страница/раздел
description: Ссылка на страницу или наименование раздела

- type: textarea
id: problems
attributes:
label: 'Неучтенные кейсы документации'
description: |
* Нераскрытые в документации вопросы (можно ссылками на обсуждение).
* Примеры неправильного использования
* Прочие, желательно реальные, примеры проблем связанных с документацией
- type: textarea
id: tasks
attributes:
label: Перечень необходимых доработок
value: |
- [ ] Описать то-то
- [ ] Исправить опечатку там то
- [ ] Дополнить примерами такой то раздел

0 comments on commit 1189797

Please sign in to comment.