Skip to content

Commit 712d864

Browse files
committed
Merge branch 'main' into dev
# Conflicts: # docs/site/docs/test-doubles/emulating-ijsruntime.md
2 parents 4f37ca4 + 74fd44b commit 712d864

35 files changed

Lines changed: 327 additions & 298 deletions

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,14 @@ about: Create a report to help us improve
44
title: ''
55
labels: ''
66
assignees: ''
7-
87
---
98

10-
**NOTE:** _Remove any parts of the template you do not need and replace the default text in each section with your own, including this._
9+
<!-- **NOTE:** Remove any parts of the template you do not need and
10+
replace the default text in each section with your own, including this. -->
11+
12+
**Describe the bug**
1113

12-
**Describe the bug or question**
13-
_A clear and concise description of what the bug or question is._
14+
<!-- A clear and concise description of the bug. This include a list of reproduction steps. -->
1415

1516
**Example:**
1617
Testing this component:
@@ -32,11 +33,15 @@ Message output from running the test.
3233
```
3334

3435
**Expected behavior:**
35-
A clear and concise description of what you expected to happen.
36+
37+
<!-- A clear and concise description of what you expected to happen. -->
3638

3739
**Version info:**
38-
- Library version:
39-
- .NET Core/Blazor version:
40+
41+
- bUnit version:
42+
- .NET Runtime and Blazor version:
43+
- OS type and version:
4044

4145
**Additional context:**
42-
Add any other context about the problem here.
46+
47+
<!-- Add any other context about the problem here. -->
Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,26 @@
11
---
22
name: Feature request
3-
about: Suggest an idea for this project
3+
about: Suggest an idea or enhancement for this project
44
title: ''
55
labels: ''
66
assignees: ''
77

88
---
99

10-
**NOTE:** _Remove any parts of the template you do not need and replace the default text in each section with your own, including this._
10+
<!-- NOTE: Remove any parts of the template not needed and fill in as needed. -->
1111

12-
**Is your feature request related to a problem? Please describe.**
13-
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
**Is the feature request related to a problem? Please elaborate.**
1413

15-
**Describe the solution you'd like**
16-
A clear and concise description of what you want to happen.
14+
<!-- A clear and concise description of what the problem is. -->
1715

18-
**Describe alternatives you've considered**
19-
A clear and concise description of any alternative solutions or features you've considered.
16+
**The suggested solution**
17+
18+
<!-- A clear and concise description of the suggested solution. -->
19+
20+
**Describe any alternative solutions**
21+
22+
<!-- A clear and concise description of any alternative solutions or features considered. -->
2023

2124
**Additional context**
22-
Add any other context or screenshots about the feature request here.
25+
26+
<!-- Add any other context or screenshots about the feature request here. -->

.github/pull_request_template.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,12 @@
55
-->
66

77
### PR meta checklist
8-
- [ ] Pull request is targeting at `DEV` branch.
8+
- [ ] Pull request is targeted at `DEV` branch for code
9+
or targeted at `main` branch for documentation that is live on bunit.egilhansen.com.
910
- [ ] Pull request is linked to all related issues, if any.
1011
- [ ] I have read the _CONTRIBUTING.md_ document.
1112

12-
### Content checklist
13+
### Code PR specific checklist
1314
- [ ] My code follows the code style of this project and AspNetCore coding guidelines.
1415
- [ ] My change requires a change to the documentation.
1516
- [ ] I have updated the documentation accordingly.

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,10 @@ A huge thank you to the [sponsors of my work with bUnit](https://github.com/spon
4040
<table>
4141
<tr>
4242
<td align="center" width="120">
43-
<a src="https://github.com/Progress-Telerik"><img src="https://avatars3.githubusercontent.com/u/57092419?s=460&u=fd421a2b423c3cad85866976935df3d4bec2ace3&v=4" alt="@Progress-Telerik" width="40" height="40" /></a><br/><a href="https://github.com/Progress-Telerik">Progress-Telerik</a>
43+
<a src="https://github.com/Progress-Telerik"><img src="https://avatars3.githubusercontent.com/u/57092419?s=460&u=fd421a2b423c3cad85866976935df3d4bec2ace3&v=4" alt="@Progress-Telerik" class="avatar" width="72" height="72" /></a><br/><a href="https://github.com/Progress-Telerik">Progress-Telerik</a>
4444
</td>
4545
<td align="center" width="120">
46-
<a src="https://github.com/hassanhabib"><img src="https://avatars0.githubusercontent.com/u/1453985?s=460&v=4" alt="Hassan Rezk Habib (@hassanhabib)" width="40" height="40" /></a><br/><a href="https://github.com/hassanhabib">Hassan Rezk Habib (@hassanhabib)</a>
46+
<a src="https://github.com/hassanhabib"><img src="https://avatars0.githubusercontent.com/u/1453985?s=460&v=4" alt="Hassan Rezk Habib (@hassanhabib)" width="72" height="72" class="avatar" /></a><br/><a href="https://github.com/hassanhabib">Hassan Rezk Habib (@hassanhabib)</a>
4747
</td>
4848
</tr>
4949
</table>

docs/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,16 @@ Here is a small getting started guide for contributing to the documentation...
99
1. The `site` folder contains the code for generating the documentation site, _and_ the documentation in markdown files, located in `site/docs`.
1010
2. The `samples` folder projects for the sample code that is displayed in the documentation. It has the following projects:
1111
- `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 xUnit based 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.
1616

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.
1818

1919
## Building and Viewing Docs Locally
2020

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:
2222

2323
1. From `docs/site` run `dotnet build`. If you get warnings from running `dotnet build`, try running it again.
2424
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:
2929
- 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
3030
- 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).
3131
- 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).
File renamed without changes.

docs/samples/tests/xunit/ReRenderTest.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ public void RendersViaInvokeAsync()
4747
{
4848
// Arrange - renders the Heading component
4949
using var ctx = new TestContext();
50-
var cut = ctx.RenderComponent<ImparativeCalc>();
50+
var cut = ctx.RenderComponent<Calc>();
5151

5252
// Indirectly re-renders through the call to StateHasChanged
5353
// in the Calculate(x, y) method.

docs/site/docs.csproj

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
11
<Project Sdk="Microsoft.NET.Sdk">
22

33
<PropertyGroup>
4-
<TargetFramework>netcoreapp3.1</TargetFramework>
4+
<TargetFramework>net5.0</TargetFramework>
55
</PropertyGroup>
66

77
<ItemGroup>
8-
<PackageReference Include="docfx.console" Version="2.56.2" PrivateAssets="All" />
8+
<PackageReference Include="docfx.console" Version="2.56.6">
9+
<PrivateAssets>all</PrivateAssets>
10+
<IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
11+
</PackageReference>
912
</ItemGroup>
1013

1114
</Project>

docs/site/docs/code-of-conduct.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ title: Contributor Covenant Code of Conduct
77

88
## Our Pledge
99

10-
In the interest of fostering an open and welcoming environment, we as
10+
In the interests of fostering an open and welcoming environment, we as
1111
contributors and maintainers pledge to make our project and
1212
community a harassment-free experience for everyone, regardless of age,
1313
size, disability, ethnicity, sexuality, gender identity and expression,
@@ -27,8 +27,7 @@ include:
2727

2828
Examples of unacceptable behavior by participants include:
2929

30-
* The use of sexualized language or imagery and unwelcome sexual attention or
31-
advances
30+
* The use of sexualized language or imagery and unwelcome sexual attention or advances
3231
* Trolling, insulting/derogatory comments, and personal or political attacks
3332
* Public or private harassment
3433
* Publishing others' private information, such as a physical or electronic
@@ -44,9 +43,8 @@ response to any instances of unacceptable behavior.
4443

4544
Project maintainers have the right and responsibility to remove, edit, or
4645
reject comments, commits, code, wiki edits, issues, and other contributions
47-
that are not aligned to this Code of Conduct, or to temporarily or
48-
permanently ban any contributor for other behaviors that they deem inappropriate,
49-
threatening, offensive, or harmful.
46+
that are not aligned with this Code of Conduct, or to temporarily or
47+
permanently ban any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
5048

5149
## Scope
5250

docs/site/docs/contribute.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ One of the easiest ways to contribute is to participate in discussions on GitHub
1010
## General Feedback and Discussions
1111
Start a discussion on the [bUnit discussion list](https://github.com/egil/bUnit/discussions).
1212

13-
## Bugs and feature requests
13+
## Bugs and Feature Requests
1414
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.
1515

1616
## Contributing Code and Content
@@ -21,7 +21,7 @@ bUnit accepts fixes and features. Here is what you should do when writing code f
2121
- 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.
2222
- All code changes should be done on the `DEV` branch, and pull requests should target it.
2323
- 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.
2525

2626
Here are some resources to help you get started on how to contribute code or new content:
2727

@@ -42,4 +42,4 @@ If you don't know what a pull request is, read this article: https://help.github
4242

4343
## Code of Conduct
4444

45-
See <xref:code-of-conduct>
45+
See <xref:code-of-conduct>

0 commit comments

Comments
 (0)