From fdfaa1f81f769d26c2db021cfe7e29c7b7fac2e8 Mon Sep 17 00:00:00 2001
From: Kayvan Sylvan <kayvan@sylvan.com>
Date: Fri, 13 Jun 2025 17:35:17 -0700
Subject: [PATCH] chore: add VSCode settings and update README.md
 (markdown-lint) (#209)

* chore: add VSCode settings and update README for clarity**

### CHANGES
- Add recommended extensions for VSCode in `extensions.json`
- Create `settings.json` for custom spell-checker words
- Update README to specify plaintext in code block

* chore: add other technical words to cspell dictionary

---------

Co-authored-by: Brian <bmadcode@gmail.com>
---
 .vscode/extensions.json |  6 ++++++
 .vscode/settings.json   | 40 ++++++++++++++++++++++++++++++++++++++++
 README.md               |  2 +-
 3 files changed, 47 insertions(+), 1 deletion(-)
 create mode 100644 .vscode/extensions.json
 create mode 100644 .vscode/settings.json

diff --git a/.vscode/extensions.json b/.vscode/extensions.json
new file mode 100644
index 00000000..aef996fd
--- /dev/null
+++ b/.vscode/extensions.json
@@ -0,0 +1,6 @@
+{
+	"recommendations": [
+		"davidanson.vscode-markdownlint",
+		"streetsidesoftware.code-spell-checker"
+	]
+}
diff --git a/.vscode/settings.json b/.vscode/settings.json
new file mode 100644
index 00000000..3d76cbb5
--- /dev/null
+++ b/.vscode/settings.json
@@ -0,0 +1,40 @@
+{
+	"cSpell.words": [
+		"agentic",
+		"Axios",
+		"BMAD",
+		"Centricity",
+		"dataclass",
+		"docstrings",
+		"emergently",
+		"explorative",
+		"frontends",
+		"golint",
+		"Goroutines",
+		"HSTS",
+		"httpx",
+		"Immer",
+		"implementability",
+		"Inclusivity",
+		"Luxon",
+		"pasteable",
+		"Pino",
+		"Polyrepo",
+		"Pydantic",
+		"pyproject",
+		"rescope",
+		"roadmaps",
+		"roleplay",
+		"runbooks",
+		"Serilog",
+		"shadcn",
+		"structlog",
+		"Systemization",
+		"taskroot",
+		"Testcontainers",
+		"tmpl",
+		"VARCHAR",
+		"venv",
+		"WCAG"
+	]
+}
diff --git a/README.md b/README.md
index 98c9ad8b..e8c07495 100644
--- a/README.md
+++ b/README.md
@@ -70,7 +70,7 @@ npm run validate       # Validate configurations
 
 ## Project Structure
 
-```
+```plaintext
 .bmad-core/
 ├── agents/          # Individual agent definitions
 ├── agent-teams/     # Team configurations