mirror of
https://github.com/itdoginfo/podkop.git
synced 2025-12-06 03:26:51 +03:00
Add template for issues and PR
This commit is contained in:
73
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
73
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
@@ -0,0 +1,73 @@
|
|||||||
|
---
|
||||||
|
name: 🐛 Сообщение об ошибке
|
||||||
|
title: "[BUG] "
|
||||||
|
labels: ["bug"]
|
||||||
|
assignees: []
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
Спасибо за создание отчета об ошибке! 🐛
|
||||||
|
|
||||||
|
Перед отправкой, пожалуйста:
|
||||||
|
- Проверьте [существующие issues](https://github.com/itdoginfo/podkop/issues)
|
||||||
|
- Просмотрите [документацию](https://podkop.net)
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: description
|
||||||
|
attributes:
|
||||||
|
label: 📝 Описание проблемы
|
||||||
|
description: Четкое и краткое описание того, что не работает
|
||||||
|
placeholder: Опишите проблему
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: reproduction
|
||||||
|
attributes:
|
||||||
|
label: Шаги для воспроизведения
|
||||||
|
description: Шаги для воспроизведения проблемы. Если вы настраваете что-то по мануалу, приложите ссылку на него.
|
||||||
|
placeholder: |
|
||||||
|
1.
|
||||||
|
2.
|
||||||
|
3.
|
||||||
|
4.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: expected
|
||||||
|
attributes:
|
||||||
|
label: ✅ Ожидаемое поведение
|
||||||
|
description: Четкое и краткое описание того, что должно было произойти
|
||||||
|
placeholder: Опишите ожидаемое поведение
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: environment
|
||||||
|
attributes:
|
||||||
|
label: 🖥️ Информация о системе
|
||||||
|
description: |
|
||||||
|
Информация о вашей системе (заполните всё применимое)
|
||||||
|
value: |
|
||||||
|
- **OpenWrt версия**:
|
||||||
|
- **Podkop версия**:
|
||||||
|
- **Роутер модель**:
|
||||||
|
- **Sing-box версия**:
|
||||||
|
render: markdown
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: config
|
||||||
|
attributes:
|
||||||
|
label: ⚙️ Конфигурация
|
||||||
|
description: |
|
||||||
|
Релевантные части конфигурации (удалите чувствительную информацию!)
|
||||||
|
placeholder: |
|
||||||
|
Например:
|
||||||
|
- Содержимое /etc/config/podkop
|
||||||
|
- Конфигурация sing-box (если релевантно)
|
||||||
|
- Дополнительные конфиги, которые потребуются wireless/network/dhcp и т.д.
|
||||||
|
render: shell
|
||||||
8
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
8
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
blank_issues_enabled: false
|
||||||
|
contact_links:
|
||||||
|
- name: 💬 Если у вас что-то не работает, прежде всего прочитайте README проекта
|
||||||
|
url: https://github.com/itdoginfo/podkop
|
||||||
|
- name: 📚 Если вы не нашли в README документацию, то вот ссылка на неё
|
||||||
|
url: https://podkop.net
|
||||||
|
about: Официальная документация PodKop
|
||||||
|
- name: Если у вас запрос новой функции или баг, выберите подходящий шаблон
|
||||||
68
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
68
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
@@ -0,0 +1,68 @@
|
|||||||
|
---
|
||||||
|
name: ✨ Запрос новой функции
|
||||||
|
description: Предложите новую функцию или улучшение для Podkop
|
||||||
|
title: "[FEATURE] "
|
||||||
|
labels: ["enhancement", "needs-discussion"]
|
||||||
|
assignees: []
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
Спасибо за предложение новой функции!
|
||||||
|
|
||||||
|
Перед отправкой, пожалуйста:
|
||||||
|
- Проверьте [существующие запросы](https://github.com/itdoginfo/podkop/issues?q=is%3Aissue+label%3Aenhancement)
|
||||||
|
- Убедитесь, что функции не существует в [документации](https://podkop.net)
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: summary
|
||||||
|
attributes:
|
||||||
|
label: Краткое описание
|
||||||
|
description: Краткое описание предлагаемой функции
|
||||||
|
placeholder: В одном предложении опишите, что вы хотите добавить...
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: problem
|
||||||
|
attributes:
|
||||||
|
label: Проблема, которую решает
|
||||||
|
description: |
|
||||||
|
Описание проблемы или неудобства, которое решит эта функция
|
||||||
|
placeholder: |
|
||||||
|
Сейчас нет возможности [...]
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: solution
|
||||||
|
attributes:
|
||||||
|
label: 💡 Предлагаемое решение
|
||||||
|
description: Четкое и краткое описание того, что вы хотите реализовать
|
||||||
|
placeholder: |
|
||||||
|
Я хочу, чтобы Podkop мог [...]
|
||||||
|
Предлагаю добавить функцию, которая [...]
|
||||||
|
Можно было бы улучшить [...] путем [...]
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: alternatives
|
||||||
|
attributes:
|
||||||
|
label: Workaround
|
||||||
|
description: |
|
||||||
|
Опишите альтернативные решения или функции, которые вы рассматривали
|
||||||
|
Есть ли обходные пути, которые вы используете сейчас?
|
||||||
|
placeholder: |
|
||||||
|
Сейчас я решаю это проблему путем [...]
|
||||||
|
Альтернативой могло бы быть [...]
|
||||||
|
Пробовал использовать [...], но это не подходит потому что [...]
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: implementation
|
||||||
|
attributes:
|
||||||
|
label: Идеи реализации (опционально)
|
||||||
|
description: |
|
||||||
|
Если у вас есть идеи о том, как это можно реализовать, поделитесь ими. Помните про ограничения LuCI.
|
||||||
|
placeholder: |
|
||||||
|
Это можно реализовать с помощью [...]
|
||||||
12
.github/pull_request_template.md
vendored
Normal file
12
.github/pull_request_template.md
vendored
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# Описание изменений
|
||||||
|
|
||||||
|
Краткое описание ваших изменений и их цель.
|
||||||
|
|
||||||
|
## Что изменено
|
||||||
|
|
||||||
|
Детальное описание изменений:
|
||||||
|
-
|
||||||
|
-
|
||||||
|
-
|
||||||
|
|
||||||
|
(Этим вы экономите время ревьювера)
|
||||||
Reference in New Issue
Block a user