Skip to content

Commit 2109a04

Browse files
authored
📝 Add testing section
Signed-off-by: Lamparter <[email protected]>
1 parent 7526442 commit 2109a04

File tree

1 file changed

+30
-6
lines changed

1 file changed

+30
-6
lines changed

readme.md

Lines changed: 30 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,18 +14,19 @@ Octokit.GraphQL.NET gives you access to the GitHub GraphQL API from .NET. It exp
1414
> [!NOTE]
1515
> This software is currently in beta. There are few things left, and there might be bugs - be warned!
1616
17-
## Getting started with GitHub GraphQL API
17+
## Getting started
1818

1919
To learn more about GitHub GraphQL API, visit [GitHub Docs](https://docs.github.com/graphql/overview)
2020

21-
## Usage
21+
To install the package from the command line, run the following command:
2222

23-
1. Install the NuGet package
2423
```ps1
2524
Install-Package Octokit.GraphQL -IncludePrerelease
2625
```
27-
2. Feed the package
28-
```C#
26+
27+
## Usage scenarios
28+
29+
```cs
2930
using Octokit.GraphQL;
3031
using static Octokit.GraphQL.Variable;
3132

@@ -55,7 +56,7 @@ var result = await connection.Run(query, vars);
5556
Console.WriteLine(result.Login + " & " + result.Name + " Rocks!");
5657
```
5758

58-
```C#
59+
```cs
5960
using Octokit.GraphQL;
6061
using Octokit.GraphQL.Model;
6162
using System;
@@ -93,3 +94,26 @@ if(activeSponsor != null)
9394
Console.WriteLine("Thanks for sponsoring Warren");
9495
}
9596
```
97+
98+
## 🧪 Running tests
99+
100+
### 1️⃣ Prerequisites
101+
102+
Ensure you have following components:
103+
104+
- [Git](https://git-scm.com/)
105+
- [Visual Studio and the .NET SDK](https://visualstudio.microsoft.com/vs/)
106+
107+
### 2️⃣ Git
108+
109+
Clone the repository:
110+
111+
```git
112+
git clone https://github.com/octokit/octokit.graphql.net
113+
```
114+
115+
### 3️⃣ Test the project
116+
117+
- Open `Octokit.GraphQL.sln`.
118+
- Set the Startup Project to `Octokit.GraphQL.UnitTests` or another test project as appropriate
119+
- Build with `DEBUG|x64` (or `DEBUG|Any CPU`)

0 commit comments

Comments
 (0)