Skip to content

Commit 8f0a2c7

Browse files
authored
Update create-test-project.md (#182)
Some suggested edits to improve readability.
1 parent 9906f8a commit 8f0a2c7

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

docs/site/docs/getting-started/create-test-project.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ title: Creating a new bUnit Test Project
55

66
# Creating a new bUnit Test Project
77

8-
To write tests, you need a place to put them - a test project. bUnit is not a unit test runner, so a general-purpose test framework, like xUnit, NUnit, or MSTest, is needed, in addition to bUnit, to write and run tests.
8+
To write tests, you need a place to put them - a test project. bUnit is not a unit test runner, so a general-purpose test framework, like xUnit, NUnit, or MSTest, is needed in addition to bUnit, to write and run tests.
99

10-
To use bUnit with xUnit, the easiest approached is using the bUnit project template described in the [Create a test project with bUnit template](#create-a-test-project-with-bunit-template) section further down the page. To create a test project manually in a general-purpose testing frameworks agnostic way, read the following section.
10+
To use bUnit with xUnit, the easiest approached is to use the bUnit project template described in the [Create a test project with bUnit template](#create-a-test-project-with-bunit-template) section further down the page. To create a test project manually, in a general-purpose testing frameworks agnostic way, read the following section.
1111

1212
## Create a Test Project Manually
1313

14-
This section will take you through the steps listed below to manually create a project for testing Blazor components, that uses either of three general purpose test frameworks. Read the rest of the section to get the all the details. Skip any steps you have already previously completed, e.g. if you already have a test project.
14+
This section will take you through the steps required to create a project for testing Blazor components using bUnit. Any of the three general purpose test frameworks shown in step 1 below can be used.
1515

1616
1. Create a new xUnit/NUnit/MSTest testing project
1717
2. Add bUnit to the test project
@@ -44,11 +44,11 @@ dotnet new mstest -o <NAME OF TEST PROJECT>
4444

4545
***
4646

47-
where `-o <NAME OF PROJECT>` is used to name the test project.
47+
where `-o <NAME OF PROJECT>` refers to the name of the test project.
4848

4949
**2. Add bUnit to the test project**
5050

51-
To add bUnit to the test project, change to the newly created test projects folder and then use the following command:
51+
To add bUnit to the test project, change to the newly created test projects folder and use the following command:
5252

5353
# [xUnit](#tab/xunit)
5454

@@ -76,7 +76,7 @@ dotnet add package bunit.web --version #{NBGV_NuGetPackageVersion}#
7676

7777
**3. Configure project settings**
7878

79-
The test projects setting needs to be set accordingly:
79+
The test projects setting needs to be set to the following:
8080

8181
- the project's SDK to `Microsoft.NET.Sdk.Razor`
8282
- set `RazorLangVersion` to `3.0`
@@ -99,14 +99,14 @@ To do so, change the first part of the test projects `.csproj` file to look like
9999

100100
**4. Add the test project to your solution**
101101

102-
If using Visual Studio, add the test project to your solution (`.sln`), and add a reference between the test project and project containing the components that should be tested:
102+
If using Visual Studio, add the test project to your solution (`.sln`), and add a reference between the test project and project containing the components that are to be tested:
103103

104104
```dotnetcli
105105
dotnet sln <NAME OF PROJECT>.sln add <NAME OF TEST PROJECT>
106106
dotnet add <NAME OF COMPONENT PROJECT>.csproj reference <NAME OF TEST PROJECT>.csproj
107107
```
108108

109-
The result should be a test project with a `.csproj` that looks like this (other packages than bUnit might have different version numbers):
109+
The result should be a test project with a `.csproj` that looks like this (non bUnit packages may have different version numbers):
110110

111111
# [xUnit](#tab/xunit)
112112

@@ -188,7 +188,7 @@ The result should be a test project with a `.csproj` that looks like this (other
188188

189189
## Create a Test Project with bUnit Template
190190

191-
To skip a few steps in the guide above, use the [bUnit test project template](https://www.nuget.org/packages/bunit.template/). The bUnit project template is only available for using with xUnit as the general-purpose testing framework, but that will change in the future.
191+
To skip a few steps in the guide above, use the [bUnit test project template](https://www.nuget.org/packages/bunit.template/). The bUnit project template currently only works with the xUnit general-purpose testing framework, others framework will be supported in the future.
192192

193193
The steps are as follows:
194194

@@ -229,4 +229,4 @@ dotnet add <NAME OF COMPONENT PROJECT>.csproj reference <NAME OF TEST PROJECT>.c
229229

230230
To start creating tests, continue reading the <xref:writing-csharp-tests> and <xref:writing-razor-tests> pages.
231231

232-
For addition tips and tricks that will make writing tests easier, see the <xref:misc-test-tips> page.
232+
For addition tips and tricks that will make writing tests easier, see the <xref:misc-test-tips> page.

0 commit comments

Comments
 (0)