diff --git a/.github/wordlist.txt b/.github/wordlist.txt index 21191c00..ca437090 100644 --- a/.github/wordlist.txt +++ b/.github/wordlist.txt @@ -23,3 +23,4 @@ TimeSeries triaging www yml +runsettings diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a79f7348..1f211093 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -113,6 +113,19 @@ e.g: dotnet test --environment="REDIS=127.17.0.1:6379" ``` +Most of the integration tests rely on specific server capabilities, +so, to be able run matching test cases properly you will need to set `REDIS_VERSION` variable with your actual server version that tests running against. +```bash +dotnet test --environment="REDIS=" --environment="REDIS_VERSION=" +``` +e.g: +```bash +dotnet test --environment="REDIS=127.17.0.1:6379" --environment="REDIS_VERSION=7.4.0" +``` + +If you are relying on an IDE to run the tests, then you can set these parameters in [.runsettings](.vscode/.runsettings) file. +You also need to check if your IDE supports [settings.json](.vscode/settings.json) for this to work. + To run your tests against an oss cluster: ```bash dotnet test --environment "REDIS_CLUSTER=" --environment "NUM_REDIS_CLUSTER_NODES=" diff --git a/README.md b/README.md index 0c96178e..d87dc2f7 100644 --- a/README.md +++ b/README.md @@ -154,9 +154,12 @@ ft.DropIndex("myIndex"); More examples can be found in the [examples folder](Examples). +## For Contributors +To contribute NRedisStack, please see :point_right: [Contribution notes](CONTRIBUTING.md) + ------ -### Author +# Author NRedisStack is developed and maintained by [Redis Inc](https://redis.com). It can be found [here]( https://github.com/redis/NRedisStack), or downloaded from [NuGet](https://www.nuget.org/packages/NRedisStack).