Skip to content

Commit 72b72e1

Browse files
committed
Add .NET Linting instructions
1 parent 4c2cb53 commit 72b72e1

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

dotnetv3/README.md

+20
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,26 @@ In general, follow these steps:
4949
and a **.csproj** file.
5050
4. Run the project using the ```dotnet run``` command.
5151

52+
## Linting
53+
We rely on [dotnet-format](https://github.com/dotnet/format) to keep this code consistently formatted and styled.
54+
To contribute .NET code to this project, please refer to the following installation and usage steps.
55+
56+
### Using dotnet-format
57+
We run dotnet-format using [a custom configuration file](.editorconfig) against any changed file or directory. See the [.NET Github Action workflow](../.github/workflows/dotnet-check.yml) for details.
58+
59+
To invoke dotnet-format yourself, first install it with
60+
61+
```
62+
dotnet tool install -g dotnet-format`.
63+
```
64+
65+
Next, run the dotnet-format command in the directory of your solution or project:
66+
67+
```
68+
dotnet format
69+
```
70+
71+
5272
## Tests
5373
⚠️ Running the tests might result in charges to your AWS account.
5474

0 commit comments

Comments
 (0)