Разработка¶
Информация для разработчиков: локальный запуск, тестирование, деплой.
Содержание¶
Требования к окружению¶
| Компонент | Версия | Назначение |
|---|---|---|
| .NET SDK | 8.0+ | Runtime |
| PostgreSQL | 14+ | База данных |
| RabbitMQ | 3.12+ | Message queue |
| Python | 3.10+ | Документация (MkDocs) |
| Docker | 20.10+ | Контейнеризация |
Структура репозитория¶
FuelProcessing/
├── FuelProcessing.Core/ # Domain Layer
├── FuelProcessing.Data/ # Data Access Layer
├── FuelProcessing.Web/ # MVC Web Interface
├── FuelProcessing.ClientApi/ # REST API
├── FuelProcessing.TransactionHandler/ # Background Jobs
├── FuelProcessing.ReportGenerationHandler/ # Reports
├── FuelProcessing.Tests/ # Unit Tests
├── docs/ # MkDocs документация
├── docker-compose.yml # Docker конфигурация
└── .gitlab-ci.yml # CI/CD
Участие в разработке¶
- Fork репозитория
- Создайте feature branch:
git checkout -b feature/my-feature - Commit changes:
git commit -m 'Add feature' - Push:
git push origin feature/my-feature - Create Pull Request
Code Style¶
- **C#:**遵循 .NET coding conventions
- JSON: 2 spaces indentation
- Markdown: 80 characters line length
Коммит сообщения¶
Types:
- feat — новая функциональность
- fix — исправление бага
- docs — документация
- refactor — рефакторинг
- test — тесты
- chore — рутинные задачи
Example:
feat(core): add card status validation
Add validation for card status transitions to prevent
invalid state changes.
Closes #123
Полезные команды¶
# Сборка решения
dotnet build
# Запуск тестов
dotnet test
# Применение миграций
dotnet ef database update
# Создание новой миграции
dotnet ef migrations add MyMigration
# Запуск документации
cd docs && mkdocs serve
# Сборка Docker образов
docker-compose build
Связанная документация¶
- Архитектура — устройство системы
- Модули — компоненты системы