Skip to content

Commit

Permalink
Add some dev notes
Browse files Browse the repository at this point in the history
  • Loading branch information
tylerlong committed Apr 25, 2024
1 parent 5b9c459 commit 12c0aa8
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,18 +147,23 @@ cd <ProjectName>
dotnet pack
```


## Todo

- Add batch get to auto-generated sample code
- Exception error message for binary data? Will it print a LOT?
- Add icons to NuGet packages


## Development Notes

I tried to migrate from Newtonsoft.Json to System.Text.Json, but it's not easy.
Especially System.Text.Json doesn't automatically convert string to number. It doesn't even automatically convert double to int64.
Considering the complexity and benefits of the migration, I decided to keep using Newtonsoft.Json for now.
Ref: https://learn.microsoft.com/en-us/dotnet/standard/serialization/system-text-json/migrate-from-newtonsoft


## Code coverage

Install the following globally if you haven't done so:

```
dotnet tool install -g dotnet-reportgenerator-globaltool
```
Expand All @@ -168,7 +173,6 @@ dotnet tool install -g dotnet-reportgenerator-globaltool
```
dotnet test -settings RingCentral.Tests/coverlet.runsettings.xml
```

The result is located in RingCentral.Tests/TestResults/


Expand All @@ -177,5 +181,4 @@ The result is located in RingCentral.Tests/TestResults/
```
~/.dotnet/tools/reportgenerator -reports:"RingCentral.Tests/TestResults/239bdb87–151b-42ac-acec-1f604f8c02c5/coverage.cobertura.xml" -targetdir:RingCentral.Tests/CoverageReport -reporttypes:Html
```

Open RingCentral.Tests/CoverageReport/index.html in a browser.

0 comments on commit 12c0aa8

Please sign in to comment.