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:
loki5512344
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 модулях
|
||||
|
||||
## Скриншоты (если применимо)
|
||||
Добавьте скриншоты для демонстрации изменений.
|
||||
|
||||
## Дополнительные заметки
|
||||
Добавьте любые дополнительные заметки для ревьюеров.
|
||||
35
CODE_OF_CONDUCT.md
Normal file
35
CODE_OF_CONDUCT.md
Normal file
|
|
@ -0,0 +1,35 @@
|
|||
# Кодекс поведения
|
||||
|
||||
## Наши обязательства
|
||||
|
||||
Мы, как участники и сопровождающие проекта, обязуемся сделать участие в нашем проекте и сообществе свободным от домогательств для всех, независимо от возраста, телосложения, инвалидности, этнической принадлежности, гендерной идентичности и самовыражения, уровня опыта, образования, социально-экономического статуса, национальности, внешности, расы, религии или сексуальной идентичности и ориентации.
|
||||
|
||||
## Наши стандарты
|
||||
|
||||
Примеры поведения, способствующего созданию позитивной среды:
|
||||
|
||||
* Использование приветливого и инклюзивного языка
|
||||
* Уважение различных точек зрения и опыта
|
||||
* Конструктивное принятие критики
|
||||
* Фокус на том, что лучше для сообщества
|
||||
* Проявление эмпатии к другим участникам сообщества
|
||||
|
||||
Примеры неприемлемого поведения:
|
||||
|
||||
* Использование сексуализированного языка или образов
|
||||
* Троллинг, оскорбительные/уничижительные комментарии, личные или политические атаки
|
||||
* Публичные или приватные домогательства
|
||||
* Публикация личной информации других лиц без явного разрешения
|
||||
* Другое поведение, которое можно обоснованно считать неуместным в профессиональной среде
|
||||
|
||||
## Наши обязанности
|
||||
|
||||
Сопровождающие проекта несут ответственность за разъяснение стандартов приемлемого поведения и должны предпринимать соответствующие и справедливые корректирующие действия в ответ на любые случаи неприемлемого поведения.
|
||||
|
||||
## Применение
|
||||
|
||||
Случаи оскорбительного, домогательского или иного неприемлемого поведения могут быть сообщены путем обращения к команде проекта по адресу loki@lokili.xyz. Все жалобы будут рассмотрены и расследованы, что приведет к ответу, который будет сочтен необходимым и соответствующим обстоятельствам.
|
||||
|
||||
## Атрибуция
|
||||
|
||||
Этот Кодекс поведения адаптирован из [Contributor Covenant](https://www.contributor-covenant.org), версия 2.0.
|
||||
42
README.md
42
README.md
|
|
@ -1,20 +1,21 @@
|
|||
# Loreport
|
||||
|
||||
[](https://www.gnu.org/licenses/gpl-3.0)
|
||||
[](https://papermc.io/)
|
||||
[](https://adoptium.net/)
|
||||
[](https://papermc.io/)
|
||||
[](https://adoptium.net/)
|
||||
|
||||
Современная система репортов для Minecraft серверов с интеграцией Discord и удобным GUI.
|
||||
Современная и производительная система репортов для Minecraft серверов с поддержкой Discord интеграции и интуитивным графическим интерфейсом.
|
||||
|
||||
## ✨ Возможности
|
||||
|
||||
- 📝 **Простая система репортов** - игроки могут легко отправлять репорты на нарушителей
|
||||
- 🎨 **Красивый GUI** - интуитивно понятный интерфейс для администраторов
|
||||
- 📊 **Статистика** - подробная информация о репортах на каждого игрока
|
||||
- 🔔 **Discord интеграция** - автоматические уведомления в Discord через webhook
|
||||
- 🗄️ **Гибкая база данных** - поддержка SQLite и PostgreSQL
|
||||
- 🌐 **Мультиязычность** - настраиваемые сообщения
|
||||
- ⚡ **Высокая производительность** - оптимизирован для больших серверов
|
||||
- 📝 **Система репортов** - удобная отправка жалоб на нарушителей
|
||||
- 🎨 **Графический интерфейс** - интуитивный GUI для управления репортами
|
||||
- 📊 **Статистика и история** - детальная информация по каждому игроку
|
||||
- 🔔 **Discord интеграция** - мгновенные уведомления через webhook
|
||||
- 🗄️ **Поддержка БД** - SQLite для малых серверов, PostgreSQL для крупных
|
||||
- 🌐 **Локализация** - полностью настраиваемые сообщения
|
||||
- ⚡ **Оптимизация** - асинхронная работа с БД, минимальное влияние на TPS
|
||||
- 🔒 **Безопасность** - защита от SQL-инъекций, валидация данных
|
||||
|
||||
## 🚀 Быстрый старт
|
||||
|
||||
|
|
@ -33,14 +34,23 @@
|
|||
|
||||
## 🎯 Совместимость
|
||||
|
||||
- **Minecraft**: 1.19.2 - 1.21.4
|
||||
- **Серверное ПО**: Paper, Purpur, Pufferfish
|
||||
- **Java**: 17+
|
||||
- **Minecraft**: 1.19.2 - 1.21.11
|
||||
- **Серверное ПО**: Paper, Purpur, Pufferfish и другие Paper-форки
|
||||
- **Java**: 21+
|
||||
- **База данных**: SQLite 3.47+ или PostgreSQL 12+
|
||||
|
||||
## 🤝 Поддержка
|
||||
## 🤝 Вклад в проект
|
||||
|
||||
- [Issues](https://codeberg.org/loki5512344/Loreport/issues) - сообщения об ошибках
|
||||
- [Discussions](https://codeberg.org/loki5512344/Loreport/discussions) - вопросы и предложения
|
||||
Мы приветствуем вклад в развитие проекта! Пожалуйста, ознакомьтесь с:
|
||||
- [Code of Conduct](CODE_OF_CONDUCT.md) - правила поведения
|
||||
- [Security Policy](SECURITY.md) - политика безопасности
|
||||
- [Contributing Guidelines](.github/PULL_REQUEST_TEMPLATE.md) - руководство по созданию PR
|
||||
|
||||
## 🐛 Поддержка
|
||||
|
||||
- [Issues](https://codeberg.org/loki5512344/Loreport/issues) - сообщения об ошибках и предложения
|
||||
- [Discussions](https://codeberg.org/loki5512344/Loreport/discussions) - вопросы и обсуждения
|
||||
- Email: loki@lokili.xyz
|
||||
|
||||
## 📄 Лицензия
|
||||
|
||||
|
|
|
|||
51
SECURITY.md
Normal file
51
SECURITY.md
Normal file
|
|
@ -0,0 +1,51 @@
|
|||
# Политика безопасности
|
||||
|
||||
## Поддерживаемые версии
|
||||
|
||||
Мы активно поддерживаем следующие версии плагина:
|
||||
|
||||
| Версия | Поддержка |
|
||||
| ------ | ------------------ |
|
||||
| 1.1.x | :white_check_mark: |
|
||||
| 1.0.x | :x: |
|
||||
|
||||
## Сообщение об уязвимости
|
||||
|
||||
Если вы обнаружили уязвимость в безопасности, пожалуйста, **не создавайте публичный issue**.
|
||||
|
||||
Вместо этого:
|
||||
|
||||
1. Отправьте email на **loki@lokili.xyz** с темой "Security Vulnerability in Lorep"
|
||||
2. Опишите уязвимость максимально подробно:
|
||||
- Тип уязвимости
|
||||
- Шаги для воспроизведения
|
||||
- Потенциальное влияние
|
||||
- Предлагаемое решение (если есть)
|
||||
|
||||
### Что ожидать
|
||||
|
||||
- **Подтверждение получения** в течение 48 часов
|
||||
- **Оценка уязвимости** в течение 7 дней
|
||||
- **Исправление** в зависимости от серьезности:
|
||||
- Критические: 1-3 дня
|
||||
- Высокие: 7-14 дней
|
||||
- Средние: 14-30 дней
|
||||
- Низкие: следующий релиз
|
||||
|
||||
### Известные области безопасности
|
||||
|
||||
Плагин обрабатывает:
|
||||
- Подключения к базам данных (PostgreSQL, SQLite)
|
||||
- Пользовательский ввод в командах
|
||||
- Конфигурационные файлы
|
||||
- Данные игроков
|
||||
|
||||
Мы особенно ценим отчеты о:
|
||||
- SQL инъекциях
|
||||
- Утечках данных игроков
|
||||
- Проблемах с правами доступа
|
||||
- Уязвимостях в зависимостях
|
||||
|
||||
## Благодарности
|
||||
|
||||
Мы благодарим всех, кто ответственно сообщает об уязвимостях и помогает сделать Lorep безопаснее.
|
||||
Loading…
Add table
Add a link
Reference in a new issue