Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
69 lines (50 loc) · 2.38 KB

CONTRIBUTING.md

File metadata and controls

69 lines (50 loc) · 2.38 KB
Raw

Contributing

🌐 English · Русский

Thanks for your interest in the project! Here is a short guide.

Environment

  • .NET SDK 10 (it can build the net8.0/net9.0/net10.0 targets).
  • To run the tests for every target, the .NET 8, 9 and 10 runtimes are recommended.

Build and test

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

Run tests for a specific target:

dotnet test -c Release -f net10.0

Integration tests

tests/YandexMusic.Tests/Integration contains tests that hit the real API. They require a Yandex Music OAuth token and are skipped automatically when no token is set.

  1. Copy .env.example to .env and put your token in it: 
    YANDEX_MUSIC_TOKEN=your_token
    (.env is in .gitignore — never commit the token. You can also set the YANDEX_MUSIC_TOKEN environment variable instead of .env.)
  2. Run only the integration tests: 
    dotnet test -c Release --filter FullyQualifiedName~Integration
    Or only the unit tests (no network): 
    dotnet test -c Release --filter FullyQualifiedName!~Integration

Structure

  • src/YandexMusic — the core client library.
  • src/YandexMusic.DependencyInjection — the AddYandexMusic() DI integration.
  • samples/YandexMusic.Player — an interactive terminal music player (TUI) example.
  • tests/YandexMusic.Tests — unit and integration tests (xUnit; integration tests use the [IntegrationFact] attribute and run only when YANDEX_MUSIC_TOKEN is set).
  • docs/ — documentation (DocFX).

Conventions

  • Follow the style from .editorconfig (dotnet format helps).
  • Public methods are asynchronous and accept a CancellationToken; use ConfigureAwait(false) in library code.
  • Throw typed exceptions derived from YandexMusicException (in the YandexMusic namespace), not System.Exception.
  • NuGet package versions are managed centrally in Directory.Packages.props.
  • Accompany new functionality with tests and, when needed, documentation in docs/.

Pull request

  1. Create a branch off main.
  2. Make sure dotnet build and dotnet test pass without errors.
  3. Describe your change in the PR and add an entry to CHANGELOG.md (the Unreleased section).

License

By contributing, you agree that your contribution will be distributed under the MIT license.