From 5b8f2034c3d6b21031cd57cc61b04ecd79aaa2b4 Mon Sep 17 00:00:00 2001 From: Oscar Hinton Date: Fri, 17 Dec 2021 16:07:28 +0100 Subject: [PATCH] Add .git-blame-ignore-revs (#1349) --- .git-blame-ignore-revs | 2 ++ README.md | 20 ++++++++++++++++++++ 2 files changed, 22 insertions(+) create mode 100644 .git-blame-ignore-revs diff --git a/.git-blame-ignore-revs b/.git-blame-ignore-revs new file mode 100644 index 0000000000..456a355970 --- /dev/null +++ b/.git-blame-ignore-revs @@ -0,0 +1,2 @@ +# Apply Prettier https://github.com/bitwarden/web/pull/1347 +56477eb39cfd8a73c9920577d24d75fed36e2cf5 diff --git a/README.md b/README.md index 034e624ddf..a1478fab60 100644 --- a/README.md +++ b/README.md @@ -66,3 +66,23 @@ Where the `urls` object is defined by the [Urls type in jslib](https://github.co Code contributions are welcome! Please commit any pull requests against the `master` branch. 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. + +## Prettier + +We recently migrated to using Prettier 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 2b0a9d995e0147601ca8ae4778434a19354a60c2` +3. Resolve any merge conflicts, commit. +4. Run `npm run prettier` +5. Commit +6. Run `git merge -Xours 56477eb39cfd8a73c9920577d24d75fed36e2cf5` +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 +```