Skip to content

Chore: Add workspace-level VS Code settings for Python project consistency

Jyothi Machani requested to merge chore/vscode-settingS into dev

This MR adds a .vscode/settings.json file to the project to enforce consistent formatting, linting, and testing behavior across all contributors using VS Code.

Key features include:

  • Sets ruff as the linter and formatter
  • Integrates mypy for static type checking
  • Enables pytest with the tests/ directory
  • Auto-formats and organizes imports on save
  • Hides cache folders from the file explorer
  • Configures indentation, word wrap, and ruler guides

These settings help maintain a uniform coding experience and reduce environment-related inconsistencies across the team.

🔗 Related Issues N/A

🧪 How Has This Been Tested? ✅ Manual Testing

  • Opened project in VS Code with these settings applied
  • Verified ruff linting and formatting on save
  • Confirmed mypy and pytest integration
  • Ensured indentation, ruler, and word wrap function as configured
  • Observed expected folders being hidden in VS Code file explorer

📦 Changes Summary

  • ➕ Added .vscode/settings.json

  • Formatting: ruff, line length 100, trailing whitespace trimming

  • Linting: ruff + mypy, with ignore-missing-imports

  • Testing: Enables pytest for tests/

  • Editor UI: Indentation, wrapping, rulers, import organization

  • Git: Smart commit and auto-fetch enabled

  • File Explorer: Hides Python and lint cache folders

✅ Checklist

  • I have read the CONTRIBUTING guidelines
  • The configuration follows team conventions
  • I have tested this locally in VS Code
  • There are no security/privacy concerns introduced
  • The settings only affect the workspace and are non-intrusive to global config
Edited by Jyothi Machani

Merge request reports