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)
This commit is contained in:
@@ -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):
|
||||
|
||||
|
||||
@@ -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**:
|
||||
|
||||
Reference in New Issue
Block a user