Skip to content

Commit

Permalink
docs: Fix the CI example codes to be valid (#695)
Browse files Browse the repository at this point in the history
* docs: Fix the CI example codes to be valid

- Fixed the format of the dotnet local tool command to be as shown in the .NET docs.
- Fixed typo for "github actions"

* Fix unnatural sentences

Co-authored-by: Lasath Fernando <[email protected]>
  • Loading branch information
eai04191 and shocklateboy92 authored Nov 11, 2022
1 parent 176c0cf commit 02d9c8a
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions Docs/ContinuousIntegration.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ Normally when using a code formatter like CSharpier, you'll want to ensure that
2. Use your preferred CI/CD tool to run the following commands.
```bash
dotnet tool restore
dotnet-csharpier . --check
dotnet csharpier --check .
```
An example of a github action to accomplish this
An example Github Actions workflow to accomplish this
```yaml
name: Validate PR
on:
Expand All @@ -38,7 +38,7 @@ Normally when using a code formatter like CSharpier, you'll want to ensure that
- uses: actions/checkout@v2
- run: |
dotnet tool restore
dotnet csharpier . --check
dotnet csharpier --check .
```

0 comments on commit 02d9c8a

Please sign in to comment.