From fa0b8e8b6a83a2f6a5e0a7bc4d564e87d3bc1e3b Mon Sep 17 00:00:00 2001
From: Timo Bechtel <hi@timobechtel.com>
Date: Mon, 13 Nov 2023 14:55:17 +0100
Subject: [PATCH] docs(eslint): add comment about organizeImports in VSCode

---
 README.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/README.md b/README.md
index e746fd9..682b4c3 100644
--- a/README.md
+++ b/README.md
@@ -51,6 +51,19 @@ module.exports = {
 };
 ```
 
+Note: You should disable `source.organizeImports` in your VSCode config, as this collides with the `import/order` rule.
+
+Add the following to your VSCode config, e.g. `.vscode/settings.json`
+
+```json
+{
+  "editor.codeActionsOnSave": {
+    // use eslint import/order instead
+    "source.organizeImports": false
+  }
+}
+```
+
 ### semantic-release
 
 This repo also contains a [semantic-release](https://github.com/semantic-release/semantic-release) configuration.