mirror of
https://github.com/Flowseal/tg-ws-proxy.git
synced 2026-05-17 00:25:51 +03:00
Улучшена "архитектура" документации и настроен triage для issues (#801)
This commit is contained in:
11
.github/CODEOWNERS
vendored
Normal file
11
.github/CODEOWNERS
vendored
Normal file
@@ -0,0 +1,11 @@
|
||||
# Default owners
|
||||
* @Flowseal
|
||||
|
||||
# Automation and repository settings
|
||||
.github/** @Flowseal
|
||||
|
||||
# Documentation
|
||||
docs/** @Flowseal
|
||||
|
||||
# Core proxy implementation
|
||||
proxy/** @Flowseal
|
||||
19
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
19
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
@@ -4,17 +4,20 @@ description: Сообщить о проблеме
|
||||
labels: ['type: проблема', 'status: нуждается в сортировке']
|
||||
|
||||
body:
|
||||
- type: textarea
|
||||
id: description
|
||||
- type: input
|
||||
id: app_version
|
||||
attributes:
|
||||
label: Опишите вашу проблему
|
||||
description: Чётко опишите проблему с которой вы столкнулись
|
||||
placeholder: Описание проблемы
|
||||
label: Версия TG WS Proxy
|
||||
description: Укажите версию приложения (например, v1.2.3)
|
||||
placeholder: vX.Y.Z
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: additions
|
||||
id: description
|
||||
attributes:
|
||||
label: Дополнительные детали
|
||||
description: Если у вас проблемы с работой прокси, то приложите файл логов в момент возникновения проблемы.
|
||||
label: Опишите вашу проблему
|
||||
description: Чётко опишите проблему, с которой вы столкнулись
|
||||
placeholder: Описание проблемы
|
||||
validations:
|
||||
required: true
|
||||
6
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
6
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
@@ -0,0 +1,6 @@
|
||||
blank_issues_enabled: false
|
||||
|
||||
contact_links:
|
||||
- name: 📚 Документация
|
||||
url: https://github.com/Flowseal/tg-ws-proxy/tree/main/docs
|
||||
about: Ознакомьтесь с документацией перед созданием issue
|
||||
37
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
37
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
@@ -0,0 +1,37 @@
|
||||
name: 🚀 Предложение
|
||||
title: '[Предложение] '
|
||||
description: Предложить улучшение или новую функциональность
|
||||
labels: ['type: предложение', 'status: нуждается в сортировке']
|
||||
|
||||
body:
|
||||
- type: textarea
|
||||
id: solution
|
||||
attributes:
|
||||
label: Предлагаемое решение
|
||||
description: Опишите, как именно вы предлагаете улучшить проект
|
||||
placeholder: |
|
||||
Предлагаю добавить ...
|
||||
Это позволит ...
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: dropdown
|
||||
id: platform
|
||||
attributes:
|
||||
label: Для какой платформы актуально?
|
||||
description: Выберите платформу, если предложение связано с конкретной ОС
|
||||
options:
|
||||
- Все платформы
|
||||
- Windows
|
||||
- macOS
|
||||
- Linux
|
||||
- Другое
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: context
|
||||
attributes:
|
||||
label: Дополнительный контекст
|
||||
description: Добавьте примеры, ссылки, скриншоты или другие детали
|
||||
placeholder: Любые дополнительные материалы по предложению
|
||||
19
.github/labels.md
vendored
Normal file
19
.github/labels.md
vendored
Normal file
@@ -0,0 +1,19 @@
|
||||
# Labels Reference
|
||||
|
||||
Этот список фиксирует лейблы, которые используются в issue-шаблонах и workflow triage.
|
||||
|
||||
## Тип issue
|
||||
|
||||
- `type: проблема` — баг-репорты.
|
||||
- `type: предложение` — предложения по улучшениям.
|
||||
|
||||
## Статус issue
|
||||
|
||||
- `status: нуждается в сортировке` — новый issue, ожидает первичного triage.
|
||||
- `status: в работе` — issue взят в работу мейнтейнером.
|
||||
|
||||
## Важно
|
||||
|
||||
- Используйте лейблы строго в таком написании.
|
||||
- Не создавайте дубликаты с похожими названиями.
|
||||
- Если нужно изменить словарь лейблов, сначала обновите этот файл и связанные workflow.
|
||||
34
.github/workflows/issue-triage.yml
vendored
Normal file
34
.github/workflows/issue-triage.yml
vendored
Normal file
@@ -0,0 +1,34 @@
|
||||
name: Auto comment on new issues
|
||||
|
||||
on:
|
||||
issues:
|
||||
types: [opened]
|
||||
|
||||
permissions:
|
||||
issues: write
|
||||
|
||||
jobs:
|
||||
comment:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Comment on new issue
|
||||
uses: peter-evans/create-or-update-comment@v5
|
||||
with:
|
||||
issue-number: ${{ github.event.issue.number }}
|
||||
body: |
|
||||
Спасибо за issue и за помощь проекту ❤️
|
||||
|
||||
Чтобы не терять ваше время, сначала проверьте две вещи:
|
||||
- вы на последней версии: [Releases](https://github.com/${{ github.repository }}/releases)
|
||||
- запускали по инструкции для своей ОС: [Быстрый старт](https://github.com/${{ github.repository }}/blob/main/docs/README.md#-быстрый-старт)
|
||||
|
||||
Если проблема осталась, пожалуйста, допишите в этот issue:
|
||||
- версию `tg-ws-proxy`;
|
||||
- вашу ОС и способ запуска (релизный бинарник / из исходников);
|
||||
- короткое описание, как воспроизвести проблему (если возможно);
|
||||
- лог/текст ошибки или скриншот.
|
||||
|
||||
Частый кейс: если не грузит медиа в Telegram, проверьте раздел в документации
|
||||
«Не грузит фото/видео?» — [README](https://github.com/${{ github.repository }}/blob/main/docs/README.md#не-грузит-фотовидео).
|
||||
|
||||
После этого мы сможем быстрее воспроизвести проблему и дать точный ответ.
|
||||
Reference in New Issue
Block a user