Skip to content

CONTRIBUTING.ru.md

Latest commit

 

History

History
71 lines (52 loc) · 3.83 KB

CONTRIBUTING.ru.md

File metadata and controls

71 lines (52 loc) · 3.83 KB
Raw

Участие в разработке

🌐 English · Русский

Спасибо за интерес к проекту! Ниже — короткое руководство.

Окружение

  • .NET SDK 10 (умеет собирать таргеты net8.0/net9.0/net10.0).
  • Для запуска тестов под все таргеты желательны рантаймы .NET 8, 9 и 10.

Сборка и тесты

dotnet restore
dotnet build -c Release
dotnet test  -c Release

Запуск тестов под конкретный таргет:

dotnet test -c Release -f net10.0

Интеграционные тесты

В tests/YandexMusic.Tests/Integration есть тесты, обращающиеся к реальному API. Они требуют OAuth-токен Яндекс Музыки и автоматически пропускаются, если токен не задан.

  1. Скопируйте .env.example в .env и впишите токен: 
    YANDEX_MUSIC_TOKEN=ваш_токен
    (Файл .env в .gitignore — не коммитьте токен. Вместо .env можно задать переменную окружения YANDEX_MUSIC_TOKEN.)
  2. Запустите только интеграционные тесты: 
    dotnet test -c Release --filter FullyQualifiedName~Integration
    Или только юнит-тесты (без сети): 
    dotnet test -c Release --filter FullyQualifiedName!~Integration

Структура

  • src/YandexMusic — основная клиентская библиотека.
  • src/YandexMusic.Ynison — Ynison: состояние воспроизведения в реальном времени и пульт (отдельный пакет).
  • src/YandexMusic.Quasar — Quasar: умные колонки в локальной сети (отдельный пакет).
  • src/YandexMusic.DependencyInjection — интеграция с DI (AddYandexMusic()).
  • samples/YandexMusicTerminal — интерактивный терминальный музыкальный плеер (TUI), пример использования.
  • tests/YandexMusic.Tests — модульные и интеграционные тесты (xUnit; интеграционные используют атрибут [IntegrationFact] и запускаются только при заданной YANDEX_MUSIC_TOKEN).
  • docs/ — документация (DocFX).

Соглашения

  • Соблюдайте стиль из .editorconfig (dotnet format поможет привести код в порядок).
  • Публичные методы — асинхронные, принимают CancellationToken; в библиотечном коде используйте ConfigureAwait(false).
  • Бросайте типизированные исключения, производные от YandexMusicException (пространство имён YandexMusic), а не System.Exception.
  • Версии NuGet-пакетов задаются централизованно в Directory.Packages.props.
  • Новый функционал сопровождайте тестами и, при необходимости, документацией в docs/.

Pull request

  1. Создайте ветку от main.
  2. Убедитесь, что dotnet build и dotnet test проходят без ошибок.
  3. Опишите изменения в PR и добавьте запись в CHANGELOG.md и CHANGELOG.ru.md (раздел Unreleased).

Лицензия

Отправляя вклад, вы соглашаетесь с тем, что он будет распространяться под лицензией MIT.