From 51bfb40fadb7c6f0050f19232bfe65cc760a86ff Mon Sep 17 00:00:00 2001
From: Sunny Hirai <thesunny@gmail.com>
Date: Thu, 1 Jul 2021 17:13:56 -0700
Subject: [PATCH] Describe when we can remove lintstagedrc as a comment

---
 .lintstagedrc.js | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/.lintstagedrc.js b/.lintstagedrc.js
index 6e18743c2..1d706b574 100644
--- a/.lintstagedrc.js
+++ b/.lintstagedrc.js
@@ -1,9 +1,13 @@
 const escape = require('shell-quote').quote
 
 /**
- * Need this to fix a bug where we can't commit `pages/examples/[example].tsx`
+ * Need this to fix a bug where we can't commit `pages/examples/[example].tsx`.
  *
  * <https://github.com/okonet/lint-staged/issues/676#issuecomment-574764713>
+ *
+ * NOTE:
+ * We can remove this entire file if/when we upgrade to Prettier 2+ where this
+ * is no longer necessary according to the `lint-staged` issue.
  */
 
 module.exports = {