# 🤝 Руководство для участников Спасибо за интерес к проекту YandexMusic! Этот документ содержит рекомендации для тех, кто хочет внести свой вклад в развитие проекта. ## 📋 Содержание - [Кодекс поведения](#кодекс-поведения) - [Как начать](#как-начать) - [Процесс разработки](#процесс-разработки) - [Стандарты кода](#стандарты-кода) - [Commit сообщения](#commit-сообщения) - [Pull Requests](#pull-requests) - [Отчёты об ошибках](#отчёты-об-ошибках) - [Предложения по улучшениям](#предложения-по-улучшениям) ## 🤐 Кодекс поведения - Будьте уважительны к другим участникам - Не допускайте дискриминацию, оскорбления и враждебного поведения - Критикуйте идеи, а не людей - Решайте конфликты конструктивно ## 🚀 Как начать ### 1. Подготовка окружения ```bash # Клонируем репозиторий git clone https://git.frigat.duckdns.org/FrigaT/YandexMusic.git cd YandexMusic # Создаём ветку для своей работы git checkout -b feature/my-feature # Восстанавливаем зависимости dotnet restore # Собираем проект dotnet build ``` ### 2. Установка инструментов - **Visual Studio 2026 Enterprise** (рекомендуется) - **Visual Studio Code** + C# extension (альтернатива) - **.NET 10 SDK** ### 3. Запуск тестов ```bash dotnet test ``` ## 🔄 Процесс разработки ### Workflow ``` 1. Выберите issue или создайте новый 2. Создайте feature-ветку 3. Внесите изменения 4. Напишите/обновите тесты 5. Убедитесь что код собирается и тесты проходят 6. Создайте Pull Request 7. Ждите review 8. Исправьте замечания если нужно 9. Merge в master ``` ### Версионирование веток ``` master → Production версия ├── feature/* → Новые функции ├── bugfix/* → Исправления ошибок ├── refactor/* → Рефакторинг кода └── docs/* → Обновления документации ``` ## 📐 Стандарты кода ### Общие правила - **Язык:** C# 12 - **Платформа:** .NET 10 - **Стиль:** Microsoft C# Coding Conventions - **Документация:** Все публичные члены должны иметь XML документацию на русском ### Пример документированного кода ```csharp namespace YandexMusic.API.API; ///

API для работы с альбомами.

public class YAlbumAPI : YCommonAPI { ///

Инициализирует новый экземпляр.

/// Экземпляр основного API. public YAlbumAPI(YandexMusicApi yandex) : base(yandex) { } ///

Получает информацию об альбоме по идентификатору.

/// Идентификатор альбома /// Модель альбома или null если не найден /// Если albumId null public async Task GetAlbumAsync(string albumId) { ArgumentNullException.ThrowIfNull(albumId); // Реализация return await Task.FromResult(null); } } ``` ### Правила именования ```csharp // Классы: PascalCase public class YandexMusicApi { } // Методы: PascalCase с Async суффиксом для асинхронных public async Task GetTrackAsync(string trackId) { } // Свойства: PascalCase public YandexMusicApi Api { get; } // Приватные поля: _camelCase private readonly HttpClient _httpClient; // Параметры: camelCase public void DoSomething(string userName, int userId) { } // Локальные переменные: camelCase var trackList = new List(); ``` ### Code Style Используйте `.editorconfig` для автоматического форматирования: ```ini # Отступы - 4 пробела indent_size = 4 # Новая строка для фигурных скобок csharp_new_line_before_open_brace = all # Используйте var где возможно csharp_style_var_for_built_in_types = true # Null-forgiving operator с осторожностью csharp_style_null_forgiving_operator = false ``` ### Nullable Reference Types Всегда включен `enable`. Правила: ```csharp // ✅ Хорошо - явно указано может быть null public string? GetUserName() { } // ✅ Хорошо - явно не null public string GetTitle() => "Title"; // ❌ Плохо - неявная nullable ссылка public object GetSomething() { } // ✅ Хорошо - используйте null-coalescing var result = value ?? defaultValue; // ✅ Хорошо - используйте null-conditional var count = list?.Count ?? 0; ``` ### Асинхронное программирование ```csharp // ✅ Хорошо - async/await public async Task GetTrackAsync(string id) { return await api.Track.GetTrackAsync(id); } // ❌ Плохо - Task.Result блокирует поток public YTrack? GetTrack(string id) { return api.Track.GetTrackAsync(id).Result; } // ✅ Хорошо - ConfigureAwait(false) в библиотеках public async Task GetTrackAsync(string id) { return await api.Track.GetTrackAsync(id).ConfigureAwait(false); } ``` ### Обработка ошибок ```csharp // ✅ Хорошо public async Task GetTrackAsync(string trackId) { ArgumentNullException.ThrowIfNull(trackId); ArgumentException.ThrowIfNullOrWhiteSpace(trackId); try { return await _provider.GetTrackAsync(trackId); } catch (HttpRequestException ex) { Logger.LogError(ex, "Ошибка при получении трека"); throw; } } // ❌ Плохо - молча игнорируем ошибки public async Task GetTrackAsync(string trackId) { try { return await _provider.GetTrackAsync(trackId); } catch { } return null; } ``` ### Структура файла ```csharp using System; using System.Collections.Generic; using System.Threading.Tasks; namespace YandexMusic.API.API; ///

API для работы с треками.

public class YTrackAPI : YCommonAPI { ///

Инициализирует новый экземпляр.

public YTrackAPI(YandexMusicApi yandex) : base(yandex) { } ///

Получает трек.

public async Task GetTrackAsync(string trackId) { // реализация } ///

Получает несколько треков.

public async Task> GetTracksAsync(IEnumerable trackIds) { // реализация } } ``` ## 📝 Commit сообщения ### Формат ``` ():