Skip to content

Commit a68eb3e

Browse files
author
Lukas Geiger
committed
docs: refresh privacy and security repo hygiene
1 parent d8d898d commit a68eb3e

4 files changed

Lines changed: 52 additions & 9 deletions

File tree

.gitignore

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,13 @@ __pycache__/
33
*.py[cod]
44
*.pyo
55
*.egg-info/
6+
.pytest_cache/
7+
.mypy_cache/
8+
.ruff_cache/
9+
.coverage
10+
htmlcov/
611
dist/
712
build/
8-
*.spec
913

1014
# Virtual Environments
1115
venv/
@@ -23,7 +27,13 @@ Thumbs.db
2327

2428
# Application
2529
*.db
30+
*.db-*
31+
*.sqlite
32+
*.sqlite3
2633
*.log
34+
*.exe
35+
*.msi
36+
*.msix
2737
logs/
2838
releases/
2939
.env
@@ -32,13 +42,21 @@ credentials.json
3242
client_secret*.json
3343
token.json
3444
*.pem
45+
*.ppk
3546
*.key
47+
*.p12
48+
*.pfx
49+
known_hosts
3650
keyring/
51+
*.bak
3752

3853
# Internal
3954
AUFGABEN.txt
4055
TEST.txt
4156
TESTS.txt
4257
TESTERGEBNISSE.txt
58+
BUGREPORT.md
59+
DIAGNOSE_REPORT.md
60+
SKILL.md
4361
tmpclaude-*
4462
.claude/

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,17 @@ Format basiert auf [Keep a Changelog](https://keepachangelog.com/de/1.1.0/).
2121
- Theme-Wechsel setzt Palette und QSS gemeinsam; Light-Mode bleibt nicht mehr auf Dark-Basis hängen
2222
- Python-LSP-Erkennung startet `pylsp` jetzt auch über `python -m pylsp`,
2323
wenn das Script nicht auf `PATH` liegt, das Modul aber installiert ist.
24+
- Die Anzeige verfügbarer LSP-Server nutzt jetzt dieselbe Fallback-Prüfung wie
25+
der Serverstart; installierte `pylsp`-Module werden daher auch ohne `pylsp.exe`
26+
auf `PATH` korrekt erkannt.
2427
- LSP-Subprocess-Pipes werden beim Stoppen geschlossen; der Runtime-Test läuft
2528
dadurch ohne ResourceWarnings.
2629

2730
### Geändert
2831
- Deutschsprachige Doku sowie Python-Kommentare, Docstrings und naheliegende UI-Texte
2932
verwenden jetzt echte Umlaute statt `ae/oe/ue`
33+
- README und Security Policy präzisieren die lokale Privacy-Abgrenzung; `.gitignore`
34+
schützt zusätzliche Credential-, SSH- und SQLite-Artefakte.
3035

3136
## [0.1.0] - 2026-04-08
3237

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,8 @@ Alternativ per Doppelklick auf `start.bat`.
4646
Der Python-LSP wird bevorzugt über `pylsp` auf `PATH` gestartet. Falls das
4747
Script nach der Installation nicht auf `PATH` liegt, nutzt CodeBox den aktuellen
4848
Python-Interpreter als Fallback: `python -m pylsp`.
49+
Die Verfügbarkeitsprüfung in der Oberfläche nutzt dieselbe Fallback-Logik, sodass
50+
installierte `pylsp`-Module auch ohne separates `pylsp.exe` korrekt erkannt werden.
4951

5052
## Lokaler Windows-Build
5153

@@ -90,11 +92,16 @@ Noch offen für die nächste größere Ausbaustufe:
9092
## Datenschutz / Privacy
9193

9294
CodeBox arbeitet lokal auf Dateien, die der Nutzer öffnet. Es werden keine
93-
Zugangsdaten benötigt und keine externen Dienste kontaktiert, außer Sie starten
94-
selbst einen installierten Language Server oder externe Build-/Run-Tools.
95+
Zugangsdaten für den Editor-Grundbetrieb benötigt und keine externen Dienste
96+
kontaktiert, außer Sie starten selbst einen installierten Language Server,
97+
externe Build-/Run-Tools oder optionale Remote-Editing-Funktionen.
98+
99+
Optionale Remote-Verbindungen können zur Laufzeit SSH-Passwörter oder
100+
Schlüsselpfade verwenden. Solche Daten gehören nicht ins Repository und sollten
101+
nur in lokalen, ignorierten Konfigurationsdateien oder im System-Keyring liegen.
95102

96103
Lokale Arbeitsdateien wie `AUFGABEN.txt`, Test-Locks, `.env`-Dateien,
97-
Credentials, Logs, Datenbanken und Build-Artefakte sind über `.gitignore`
104+
Credentials, SSH-Schlüssel, Logs, Datenbanken und Build-Artefakte sind über `.gitignore`
98105
ausgeschlossen.
99106

100107
## Lizenz / License

SECURITY.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# Security Policy
22

3+
## Supported Versions
4+
5+
CodeBox is currently maintained on the `main` branch before a stable 1.0
6+
release. Please test reports against the latest `main` commit when possible.
7+
38
## Reporting a Vulnerability
49

510
If you find a security vulnerability, please report it responsibly:
@@ -14,14 +19,22 @@ If you find a security vulnerability, please report it responsibly:
1419
2. Fill out the form (title, description, severity, affected versions)
1520
3. Submit privately (not visible to public until disclosed)
1621

17-
We will respond as soon as possible.
22+
We will respond as soon as possible for a solo-maintained open-source project.
1823

1924
## Scope
2025

21-
<!-- Adjust scope for your project -->
22-
- File system access
23-
- Database access
24-
- External API connections
26+
Security reports are in scope when they affect CodeBox itself, especially:
27+
28+
- Local file access through the editor, project tree, or save/open workflows
29+
- Terminal, Git, build, and run-tool invocation from inside the application
30+
- Language Server Protocol process handling
31+
- Optional SSH/SFTP remote-editing code paths
32+
- Handling of local configuration files, credentials, logs, and build artifacts
33+
34+
Generated build outputs, personal local configuration, private test locks, and
35+
secrets accidentally created by a user are not intended to be committed. The
36+
repository `.gitignore` excludes common credential, SSH-key, database, log, and
37+
build-artifact patterns.
2538

2639
## Response
2740

0 commit comments

Comments
 (0)