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: CONTRIBUTING.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,12 @@
1
1
# Contributing to BlazorWebFormsComponents
2
2
3
-
Thank you for taking the time to consider contributing to our project.
3
+
Thank you for taking the time to consider contributing to our project.
4
4
5
5
The following is a set of guidelines for contributing to the project. These are mostly guidelines, not rules, and can be changed in the future. Please submit your suggestions with a pull-request to this document.
6
6
7
7
1.[Code of Conduct](#code-of-conduct)
8
8
1.[What should I know before I get started?](#what-should-i-know-before-i-get-started?)
@@ -28,7 +28,7 @@ This project is designed to be built and run primarily with Visual Studio 2019.
28
28
29
29
```
30
30
/docs -- User Documentation
31
-
/samples -- Usage Samples
31
+
/samples -- Usage Samples
32
32
BeforeWebForms
33
33
AfterBlazorClientSide -- Shell project with WebAssembly config
34
34
AfterBlazorServerSide -- Shared project with Server-Side config
@@ -49,7 +49,7 @@ All official versions of the project are built and delivered with Azure DevOps P
49
49
50
50
Design for this project is ultimately decided by the project lead, [Jeff Fritz](https://github.com/csharpfritz). The following project tenets are adhered to when making decisions:
51
51
52
-
1. All attributes of the original controls should be supported. This helps emphasize the 'convert your markup' feature.
52
+
1. All attributes of the original controls should be supported. This helps emphasize the 'convert your markup' feature.
53
53
1. HTML markup generated by the components should replicate the markup generated by the original controls. This helps to ensure the components behave as the Web Forms controls were expected to.
54
54
1. Minimal .NET APIs should be supported, in order to present the API. The following are the primary APIs available:
@@ -75,10 +75,10 @@ Tell us how you are currently using the web forms framework so that we can build
75
75
76
76
All code for a component should have an assigned issue that matches it. This way we can prevent contributors from working on the same feature at the same time.
77
77
78
-
Any code that is written to support a component are required to be accompanied with unit tests at the time the pull request is submitted. Pull requests without unit tests will be delayed and asked for unit tests to prove their functionality. We use the [Razor Components Testing Library](https://www.nuget.org/packages/Razor.Components.Testing.Library/) to test our components.
78
+
Any code that is written to support a component are required to be accompanied with unit tests at the time the pull request is submitted. Pull requests without unit tests will be delayed and asked for unit tests to prove their functionality. We use the [bUnit](https://www.nuget.org/packages/bunit/) to test our components.
79
79
80
80
Code for components' features should also include some definition in the `/docs` folder so that our users can identify and understand which feature is supported.
81
81
82
82
### Write documentation
83
83
84
-
The documentation for the migration and consumption of these components will be significant in scope and need to cover many scenarios. We are always looking for help to add content to the `/docs` section of the repository with proper links back through to the main `/README.md`
84
+
The documentation for the migration and consumption of these components will be significant in scope and need to cover many scenarios. We are always looking for help to add content to the `/docs` section of the repository with proper links back through to the main `/README.md`.
0 commit comments