Skip to content

Commit 99cb571

Browse files
author
Bart Koelman
committed
Added shell command for ps1 scripts
1 parent 2302008 commit 99cb571

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

.github/CONTRIBUTING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,8 @@ Please follow these steps to have your contribution considered by the maintainer
6060

6161
We use [CSharpGuidelines](https://csharpcodingguidelines.com/) as our coding standard (with a few minor exceptions). Coding style is validated during PR build, where we inject an extra settings layer that promotes various suggestions to warning level. This ensures a high-quality codebase without interfering too much when editing code.
6262
You can run the following [PowerShell scripts](https://github.com/PowerShell/PowerShell/releases) locally:
63-
- `inspectcode.ps1`: Scans the code for style violations and opens the result in your web browser.
64-
- `cleanupcode.ps1` Reformats the entire codebase to match with our configured style.
63+
- `pwsh inspectcode.ps1`: Scans the code for style violations and opens the result in your web browser.
64+
- `pwsh cleanupcode.ps1`: Reformats the entire codebase to match with our configured style.
6565

6666
Code inspection violations can be addressed in several ways, depending on the situation:
6767
- Types that are reported to be never instantiated (because the IoC container creates them dynamically) should be decorated with `[UsedImplicitly(ImplicitUseKindFlags.InstantiatedNoFixedConstructorSignature)]`.

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ dotnet build
122122
Running tests locally requires access to a PostgreSQL database. If you have docker installed, this can be propped up via:
123123

124124
```bash
125-
run-docker-postgres.ps1
125+
pwsh run-docker-postgres.ps1
126126
```
127127

128128
And then to run the tests:
@@ -134,5 +134,5 @@ dotnet test
134134
Alternatively, to build and validate the code, run all tests, generate code coverage and produce the NuGet package:
135135

136136
```bash
137-
Build.ps1
137+
pwsh Build.ps1
138138
```

docs/request-examples/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,5 +15,5 @@ curl -s http://localhost:14141/api/books
1515
[!code-json[RESPONSE](003_GET_Books-including-Author_Response.json)]
1616
```
1717

18-
3. Run `./generate-examples.ps1`
19-
4. Verify the results by running `docfx --serve`
18+
3. Run `pwsh ../generate-examples.ps1`
19+
4. Verify the results by running `pwsh ../build-dev.ps1`

0 commit comments

Comments
 (0)