From 362621ea7b45f43ce1fdc3dc4c8013f7905bc3ac Mon Sep 17 00:00:00 2001 From: Michael Vorburger Date: Tue, 7 Oct 2025 20:51:53 +0200 Subject: [PATCH] chore: Restore .vscode/settings.json, and document why --- .gitignore | 3 --- .../{settings.recommended.json => settings.json} | 0 CONTRIBUTING.md | 14 +++++++++++++- 3 files changed, 13 insertions(+), 4 deletions(-) rename .vscode/{settings.recommended.json => settings.json} (100%) diff --git a/.gitignore b/.gitignore index ca36493a..7f2c6c8f 100644 --- a/.gitignore +++ b/.gitignore @@ -23,9 +23,6 @@ target/ *.iws out/ -# VS Code files -.vscode/settings.json - # OS-specific junk .DS_Store Thumbs.db diff --git a/.vscode/settings.recommended.json b/.vscode/settings.json similarity index 100% rename from .vscode/settings.recommended.json rename to .vscode/settings.json diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1f1bc64d..7af18b09 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -75,4 +75,16 @@ adk-python for validation. ### Javadocs -We want our Javadocs to be concise and meaningful. \ No newline at end of file +We want our Javadocs to be concise and meaningful. + +## IDEs + +### VS Code + +This project includes recommended VS Code [extensions](.vscode/extensions.json) and minimal required [settings](.vscode/settings.json). + +Those minimal settings are required, and not just a recommendation or preference. +More specifically, they make sure that working with this code in VS Code matches the [code format](#format) expectations of the Maven build. + +You may also have other VS Code settings which are your "personal preferences" instead of "project requirements". +We recommend that you keep personal settings in your VS Code User Settings instead. The location of this file varies by platform (e.g., `~/.config/Code/User/settings.json` on Linux).