docs: Добавлены GitHub шаблоны и политики
- Добавлен CODE_OF_CONDUCT.md с правилами поведения - Добавлен SECURITY.md с политикой безопасности - Добавлены шаблоны issue (bug report, feature request) - Добавлен шаблон pull request - Обновлен README.md: * Версия Minecraft: 1.21.11 * Версия Java: 21+ * Расширен список возможностей * Добавлена секция о вкладе в проект
This commit is contained in:
parent
e58a1f5f3b
commit
80e610690a
6 changed files with 223 additions and 16 deletions
36
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
36
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
|
|
@ -0,0 +1,36 @@
|
|||
---
|
||||
name: Сообщение об ошибке
|
||||
about: Создайте отчет об ошибке, чтобы помочь нам улучшить плагин
|
||||
title: '[BUG] '
|
||||
labels: bug
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
## Описание ошибки
|
||||
Четкое и краткое описание того, что произошло.
|
||||
|
||||
## Шаги для воспроизведения
|
||||
1. Перейти к '...'
|
||||
2. Выполнить команду '...'
|
||||
3. Увидеть ошибку
|
||||
|
||||
## Ожидаемое поведение
|
||||
Четкое и краткое описание того, что вы ожидали увидеть.
|
||||
|
||||
## Скриншоты
|
||||
Если применимо, добавьте скриншоты для объяснения проблемы.
|
||||
|
||||
## Окружение
|
||||
- Версия Minecraft: [например, 1.21.1]
|
||||
- Версия Paper/Spigot: [например, Paper 1.21.1-116]
|
||||
- Версия плагина: [например, 1.1.0]
|
||||
- Версия Java: [например, Java 21]
|
||||
- Тип БД: [PostgreSQL/SQLite]
|
||||
|
||||
## Логи
|
||||
```
|
||||
Вставьте сюда релевантные логи из server.log или latest.log
|
||||
```
|
||||
|
||||
## Дополнительный контекст
|
||||
Добавьте любой другой контекст о проблеме здесь.
|
||||
33
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
33
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
|
|
@ -0,0 +1,33 @@
|
|||
---
|
||||
name: Запрос функции
|
||||
about: Предложите идею для этого проекта
|
||||
title: '[FEATURE] '
|
||||
labels: enhancement
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
## Описание функции
|
||||
Четкое и краткое описание того, какую функцию вы хотите видеть.
|
||||
|
||||
## Проблема, которую это решает
|
||||
Опишите проблему, с которой вы столкнулись. Например: "Я всегда расстроен, когда [...]"
|
||||
|
||||
## Предлагаемое решение
|
||||
Четкое и краткое описание того, что вы хотите видеть.
|
||||
|
||||
## Альтернативы
|
||||
Четкое и краткое описание любых альтернативных решений или функций, которые вы рассматривали.
|
||||
|
||||
## Примеры использования
|
||||
Опишите, как эта функция будет использоваться:
|
||||
```
|
||||
/example command here
|
||||
```
|
||||
|
||||
## Дополнительный контекст
|
||||
Добавьте любой другой контекст или скриншоты о запросе функции здесь.
|
||||
|
||||
## Приоритет
|
||||
- [ ] Критично для моего использования
|
||||
- [ ] Было бы очень полезно
|
||||
- [ ] Приятное дополнение
|
||||
42
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
42
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
|
|
@ -0,0 +1,42 @@
|
|||
# Pull Request
|
||||
|
||||
## Описание
|
||||
Четкое и краткое описание того, что делает этот PR.
|
||||
|
||||
## Тип изменения
|
||||
Отметьте соответствующие пункты:
|
||||
- [ ] Исправление ошибки (некритичное изменение, которое исправляет проблему)
|
||||
- [ ] Новая функция (некритичное изменение, которое добавляет функциональность)
|
||||
- [ ] Критическое изменение (исправление или функция, которая приведет к неработоспособности существующей функциональности)
|
||||
- [ ] Обновление документации
|
||||
|
||||
## Связанные Issue
|
||||
Fixes #(номер issue)
|
||||
|
||||
## Как это было протестировано?
|
||||
Опишите тесты, которые вы провели для проверки ваших изменений:
|
||||
- [ ] Юнит-тесты
|
||||
- [ ] Интеграционные тесты
|
||||
- [ ] Ручное тестирование на сервере
|
||||
|
||||
**Конфигурация тестирования**:
|
||||
- Версия Minecraft:
|
||||
- Версия Paper/Spigot:
|
||||
- Версия Java:
|
||||
- Тип БД:
|
||||
|
||||
## Чеклист
|
||||
- [ ] Мой код следует стилю кода этого проекта
|
||||
- [ ] Я провел самопроверку своего кода
|
||||
- [ ] Я прокомментировал свой код, особенно в сложных местах
|
||||
- [ ] Я внес соответствующие изменения в документацию
|
||||
- [ ] Мои изменения не генерируют новых предупреждений
|
||||
- [ ] Я добавил тесты, которые доказывают, что мое исправление эффективно или что моя функция работает
|
||||
- [ ] Новые и существующие юнит-тесты проходят локально с моими изменениями
|
||||
- [ ] Любые зависимые изменения были объединены и опубликованы в downstream модулях
|
||||
|
||||
## Скриншоты (если применимо)
|
||||
Добавьте скриншоты для демонстрации изменений.
|
||||
|
||||
## Дополнительные заметки
|
||||
Добавьте любые дополнительные заметки для ревьюеров.
|
||||
Loading…
Add table
Add a link
Reference in a new issue