You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/README.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,16 +9,16 @@ Here is a small getting started guide for contributing to the documentation...
9
9
1. The `site` folder contains the code for generating the documentation site, _and_ the documentation in markdown files, located in `site/docs`.
10
10
2. The `samples` folder projects for the sample code that is displayed in the documentation. It has the following projects:
11
11
-`samples/components`: A Blazor component library project where components under test are placed.
12
-
-`samples/tests/mstest`: A MSTest project where MSTest test samples are placed.
13
-
-`samples/tests/nunit`: A NUnit project where NUnit test samples are placed.
14
-
-`samples/tests/razor`: A xUnitbased test project where razor test samples are placed.
15
-
-`samples/tests/xunit`: A xUnit project where xUnit C#only test samples are placed.
12
+
-`samples/tests/mstest`: An MSTest project where MSTest test samples are placed.
13
+
-`samples/tests/nunit`: An NUnit project where NUnit test samples are placed.
14
+
-`samples/tests/razor`: An xUnit-based test project where razor test samples are placed.
15
+
-`samples/tests/xunit`: An xUnit project where xUnit C#-only test samples are placed.
16
16
17
-
These sample components source files and tests source files are included in the documentation using [DocFx's Code Snippet syntax](https://dotnet.github.io/docfx/spec/docfx_flavored_markdown.html?tabs=tabid-1%2Ctabid-a#code-snippet). They are created as real projects, making them runnable, which helps ensure that the code shown in the documentation pages are correct and in working order.
17
+
These sample components, source files, and tests source files are included in the documentation using [DocFx's Code Snippet syntax](https://dotnet.github.io/docfx/spec/docfx_flavored_markdown.html?tabs=tabid-1%2Ctabid-a#code-snippet). They are created as real projects, making them runnable, which helps ensure that the code samples shown in the documentation pages are correct and in working order.
18
18
19
19
## Building and Viewing Docs Locally
20
20
21
-
To build and view the documentation locally, following a few steps is required:
21
+
To build and view the documentation locally, follow these steps:
22
22
23
23
1. From `docs/site` run `dotnet build`. If you get warnings from running `dotnet build`, try running it again.
24
24
2. From `docs/` run `serve-docs.cmd`. This will start up a local web server, hosting the generated documentation site on http://localhost:8080, using the [`dotnet serve` tool](https://github.com/natemcmaster/dotnet-serve).
@@ -29,4 +29,4 @@ To build and view the documentation locally, following a few steps is required:
29
29
- All pages should have a [YAML header](https://dotnet.github.io/docfx/spec/docfx_flavored_markdown.html#yaml-header) with a `UID` to make it easy to [cross reference](https://dotnet.github.io/docfx/spec/docfx_flavored_markdown.html#cross-reference) between pages
30
30
- All page and code references should be created using the [`xref:UID` cross reference syntax](https://dotnet.github.io/docfx/tutorial/links_and_cross_references.html#using-cross-reference).
31
31
- By default, you should include code snippets as sample files in the `samples` projects, using the [code snippet syntax](https://dotnet.github.io/docfx/spec/docfx_flavored_markdown.html#code-snippet).
32
-
- All code snippets should use 2 spaces as an indention unit (1 tab = 2 spaces).
32
+
- All code snippets should use 2 spaces as an indention unit (1 tab = 2 spaces).
Copy file name to clipboardExpand all lines: docs/site/docs/contribute.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ One of the easiest ways to contribute is to participate in discussions on GitHub
10
10
## General Feedback and Discussions
11
11
Start a discussion on the [bUnit discussion list](https://github.com/egil/bUnit/discussions).
12
12
13
-
## Bugs and feature requests
13
+
## Bugs and Feature Requests
14
14
For bugs or feature requests, log a new issue on the [issues list](https://github.com/egil/bunit/issues). Be sure to use the right template.
15
15
16
16
## Contributing Code and Content
@@ -21,7 +21,7 @@ bUnit accepts fixes and features. Here is what you should do when writing code f
21
21
- Add, remove, or delete unit tests to cover your changes. Make sure tests are specific to the changes you are making. Tests need to be provided for every bug/feature that is completed.
22
22
- All code changes should be done on the `DEV` branch, and pull requests should target it.
23
23
- All updates to the documentation located under `./docs/` should be done on the `main` branch **if** they are general in nature and not tied to a specific version. Changes to the documentation related to changes on the `DEV` branch should be submitted to the `DEV` branch.
24
-
- Any code or documentation you share with the bUnit projects should fall under the projects license agreement.
24
+
- Any code or documentation you share with the bUnit projects should fall under the project's license agreement.
25
25
26
26
Here are some resources to help you get started on how to contribute code or new content:
27
27
@@ -42,4 +42,4 @@ If you don't know what a pull request is, read this article: https://help.github
0 commit comments