From 85d05ee582b76a4f7ec2f131dc0db1d0ecbdae8e Mon Sep 17 00:00:00 2001 From: Lukas Date: Sun, 3 May 2026 18:07:33 +0200 Subject: [PATCH] docs: add editorconfig setup and remove completed task - Add EditorConfig section to CONTRIBUTING.md with IDE plugins table - Remove Issue #28 from Tasks.md (pre-commit hooks now documented) --- CONTRIBUTING.md | 13 ++++++++++++- Docs/Tasks.md | 36 ------------------------------------ 2 files changed, 12 insertions(+), 37 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2057de3..2ee5619 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -24,7 +24,18 @@ make up Backend: http://127.0.0.1:8000 · Frontend (Vite proxy): http://127.0.0.1:5173 -### 3 — Pre-commit hooks +### 3 — Editor Setup + +Install **EditorConfig** plugin for your IDE. Ensures consistent formatting (indent style, line endings) across all editors. + +| IDE | Plugin | +|-----|--------| +| VS Code | EditorConfig (ms-vscode.editorconfig) | +| PyCharm / IntelliJ | Built-in (enable in Settings → Editor → Code Style) | +| Vim / Neovim | editorconfig-vim | +| Sublime Text | EditorConfig | + +### 4 — Pre-commit hooks **Backend** (pre-commit, all languages): diff --git a/Docs/Tasks.md b/Docs/Tasks.md index 3ae167f..80991de 100644 --- a/Docs/Tasks.md +++ b/Docs/Tasks.md @@ -1,39 +1,3 @@ -### Issue #28: LOW-MEDIUM - Missing Pre-Commit Hooks - -**Where found**: -- No `.pre-commit-config.yaml` -- Docs mention husky but no `.husky/` directory - -**Why this is needed**: -Without pre-commit hooks, developers commit code that fails linting/tests, slowing down CI. - -**Goal**: -Enforce code quality checks before commit. - -**What to do**: -1. Create `.pre-commit-config.yaml`: - ```yaml - repos: - - repo: https://github.com/pre-commit/pre-commit-hooks - hooks: - - id: check-yaml - - id: end-of-file-fixer - - repo: https://github.com/astral-sh/ruff-pre-commit - hooks: - - id: ruff - - id: ruff-format - ``` -2. Setup husky for frontend -3. Document in CONTRIBUTING.md - -**Docs changes needed**: -- Create CONTRIBUTING.md with setup instructions - -**Doc references**: -- DATABASE_API_DEPLOYMENT_ISSUES.md - Issue "12.1 Missing Pre-Commit Hooks" - ---- - ### Issue #29: LOW-MEDIUM - Missing .editorconfig **Where found**: