diff --git a/.git-blame-ignore-revs b/.git-blame-ignore-revs new file mode 100644 index 000000000..e6dc4e220 --- /dev/null +++ b/.git-blame-ignore-revs @@ -0,0 +1,2 @@ +# .NET format https://github.com/bitwarden/mobile/pull/1738 +04539af2a66668b6e85476d5cf318c9150ec4357 diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 4f9ae9888..0ce5e0174 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -109,9 +109,9 @@ jobs: run: dotnet tool restore shell: pwsh - # - name: Verify Format - # run: dotnet tool run dotnet-format --check - # shell: pwsh + - name: Verify Format + run: dotnet tool run dotnet-format --check + shell: pwsh - name: Run Core tests run: dotnet test test/Core.Test/Core.Test.csproj diff --git a/README.md b/README.md index 32be97200..cee1c5d5e 100644 --- a/README.md +++ b/README.md @@ -33,3 +33,23 @@ Code contributions are welcome! Visual Studio with Xamarin is required to work o Learn more about how to contribute by reading the [`CONTRIBUTING.md`](CONTRIBUTING.md) file. Security audits and feedback are welcome. Please open an issue or email us privately if the report is sensitive in nature. You can read our security policy in the [`SECURITY.md`](SECURITY.md) file. + +### Dotnet-format + +We recently migrated to using dotnet-format as code formatter. All previous branches will need to updated to avoid large merge conflicts using the following steps: + +1. Check out your local Branch +2. Run `git merge e0efcfbe45b2a27c73e9593bfd7a71fad2aa7a35` +3. Resolve any merge conflicts, commit. +4. Run `dotnet tool run dotnet-format` +5. Commit +6. Run `git merge -Xours 04539af2a66668b6e85476d5cf318c9150ec4357` +7. Push + +#### Git blame + +We also recommend that you configure git to ignore the prettier revision using: + +```bash +git config blame.ignoreRevsFile .git-blame-ignore-revs +```