Skip to content

Latest commit

 

History

History
63 lines (48 loc) · 3.51 KB

File metadata and controls

63 lines (48 loc) · 3.51 KB

Документация проекта Joinrpg.ru

Основные документы

Архитектура

Разработка

Конфигурация

Архитектурные решения (ADR)

Быстрые ссылки

Распространённые задачи

Команды

# Применить миграции
dotnet run --project src/Joinrpg.Dal.Migrate

# Проверить стиль кода
dotnet format --verify-no-changes --severity error

# Запустить тесты
dotnet test

Обновление документации

При добавлении нового функционала или обнаружении проблем:

  1. Определите, нужно ли создать новый документ или дополнить существующий
  2. Следуйте стилю существующих документов (кратко, по-русски, с примерами кода)
  3. Добавьте ссылку в этот README
  4. Убедитесь, что документация актуальна для текущей версии кода

Стиль документации

  • Пишите на русском языке
  • Используйте практические примеры из кода проекта
  • Включайте команды для выполнения задач
  • Упоминайте типичные проблемы и их решения
  • Ссылайтесь на конкретные файлы и строки кода