Skip to content

update CONTRIBUTING.md #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
caleblloyd merged 1 commit into from
May 13, 2025
Merged

update CONTRIBUTING.md #14

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,38 @@
# Contributing

## Dependencies

- .NET 8+ SDK
- Docker or Docker Desktop - The tests use Aspire to start a NATS Server Docker container

## Project Directories

- `src/NatsDistributedCache` - The main library (Class Library)
- `test/TestUtils`: Test utilities (Class Library)
- `test/UnitTests`: Unit tests (XUnit)
```bash
dotnet test test/UnitTests/UnitTests.csproj
```
- `test/IntegrationTests`: Integration tests (XUnit)
```bash
dotnet test test/IntegrationTests/IntegrationTests.csproj
```
- `util/NatsAppHost`: NATS app host (Aspire AppHost)
- `util/PerfTest`: Performance tests (Exe) - make sure to run in Release mode
```bash
dotnet run -c Release --project util/PerfTest/PerfTest.csproj
```

## Updating Packages

Use the `dotnet outdated` tool to update packages in `.csproj` files. When updating packages in a project with lock
files, always use the `-n` flag to prevent automatic restoration. To update tools themselves, edit
`.config/dotnet-tools.json`.

```bash
# run to install/update the tool
dotnet tool restore

# all updates
# view
dotnet outdated
Expand Down