From 70b56243b36d7683ec1ee02d517cee321186e2a0 Mon Sep 17 00:00:00 2001 From: shacharPash Date: Wed, 27 Sep 2023 13:09:18 +0300 Subject: [PATCH] tell the contributer to run dotnet format in the CONTRIBUTING.md --- .github/workflows/linter.yaml | 2 +- CONTRIBUTING.md | 7 ++++--- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/.github/workflows/linter.yaml b/.github/workflows/linter.yaml index 4d76533d..415e671e 100644 --- a/.github/workflows/linter.yaml +++ b/.github/workflows/linter.yaml @@ -19,7 +19,7 @@ jobs: - name: Check for modified files run: | if (git status | Select-String -Pattern 'modified') { - Write-Host "Modified files found." + Write-Host "Modified files found. Please run dotnet format and commit the changes." exit 1 } else { Write-Host "No modified files found." diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9eaade76..bb55086f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -35,9 +35,10 @@ Here's how to get started with your code contribution: 3. Write your tests 4. Use the `docker run -p 6379:6379 -it redis/redis-stack-server:edge` as your local environment for running the functional tests. You can also use Development Container as described below. -5. Make sure your tests pass using `dotnet test` -6. Push your changes to GitHub -7. Open a pull request +5. run `dotnet format` to make sure your code is formatted correctly +6. Make sure your tests pass using `dotnet test` +7. Push your changes to GitHub +8. Open a pull request ## Development Container