Skip to content

Commit c65a732

Browse files
authored
Merge pull request #12 from asynkron/add-contributing-md
Add contributing guide for build/test/release
2 parents e33e362 + 6d3e448 commit c65a732

File tree

1 file changed

+45
-0
lines changed

1 file changed

+45
-0
lines changed

CONTRIBUTING.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Contributing
2+
3+
Thanks for helping improve Asynkron.Profiler!
4+
5+
## Prerequisites
6+
7+
- .NET SDK 10 preview (see `global.json` for the pinned version).
8+
9+
## Build
10+
11+
From the repo root:
12+
13+
```sh
14+
dotnet restore
15+
dotnet build -c Release --nologo
16+
```
17+
18+
## Test
19+
20+
```sh
21+
dotnet test -c Release --nologo
22+
```
23+
24+
## Release
25+
26+
Releases are tag-based and run via GitHub Actions (`.github/workflows/pack.yml`).
27+
28+
1. Create a version tag (example):
29+
30+
```sh
31+
git tag v1.2.3
32+
git push origin v1.2.3
33+
```
34+
35+
2. The workflow packs and publishes:
36+
- `src/ProfileTool/ProfileTool.csproj`
37+
- `src/ProfilerCore/Asynkron.Profiler.Core.csproj`
38+
39+
If you need to run the pack step locally:
40+
41+
```sh
42+
VERSION=1.2.3
43+
dotnet pack -c Release -o ./nupkg src/ProfileTool/ProfileTool.csproj -p:Version="$VERSION"
44+
dotnet pack -c Release -o ./nupkg src/ProfilerCore/Asynkron.Profiler.Core.csproj -p:Version="$VERSION"
45+
```

0 commit comments

Comments
 (0)