Joachim Hummel
6299d4e815
- CHANGELOG.md: Version history (v1.0.0) - .nvmrc: Node.js version (20) - .editorconfig: Code style configuration - CONTRIBUTING.md: Contribution guidelines Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
79 lines
1.8 KiB
Markdown
79 lines
1.8 KiB
Markdown
# Contributing / Mitwirken
|
|
|
|
Danke für dein Interesse an diesem Projekt!
|
|
|
|
## Wie du beitragen kannst
|
|
|
|
### Bugs melden
|
|
|
|
1. Prüfe, ob der Bug bereits gemeldet wurde
|
|
2. Erstelle ein Issue mit:
|
|
- Beschreibung des Problems
|
|
- Schritte zur Reproduktion
|
|
- Erwartetes vs. tatsächliches Verhalten
|
|
- Node.js Version und Betriebssystem
|
|
|
|
### Feature-Anfragen
|
|
|
|
1. Erstelle ein Issue mit dem Tag "enhancement"
|
|
2. Beschreibe das gewünschte Feature und den Anwendungsfall
|
|
|
|
### Code beitragen
|
|
|
|
1. Fork das Repository
|
|
2. Erstelle einen Feature-Branch: `git checkout -b feature/mein-feature`
|
|
3. Committe deine Änderungen: `git commit -m 'Add: Mein neues Feature'`
|
|
4. Push zum Branch: `git push origin feature/mein-feature`
|
|
5. Erstelle einen Pull Request
|
|
|
|
## Entwicklung
|
|
|
|
### Setup
|
|
|
|
```bash
|
|
# Repository klonen
|
|
git clone https://git.unixweb.net/joachim/mail-service-embedded.git
|
|
cd mail-service-embedded
|
|
|
|
# Dependencies installieren
|
|
npm install
|
|
|
|
# Konfiguration erstellen
|
|
cp .env.example .env
|
|
# .env bearbeiten
|
|
|
|
# Server starten
|
|
npm run dev
|
|
```
|
|
|
|
### Code-Style
|
|
|
|
- 2 Spaces für Einrückung
|
|
- Semikolons am Zeilenende
|
|
- Einfache Anführungszeichen für Strings
|
|
- Keine trailing whitespace
|
|
|
|
Der `.editorconfig` sorgt automatisch für konsistente Formatierung.
|
|
|
|
### Commit-Messages
|
|
|
|
Format: `<type>: <description>`
|
|
|
|
| Type | Beschreibung |
|
|
|------|--------------|
|
|
| Add | Neue Funktion |
|
|
| Fix | Bugfix |
|
|
| Update | Verbesserung bestehender Funktion |
|
|
| Remove | Entfernung von Code/Features |
|
|
| Docs | Dokumentation |
|
|
| Refactor | Code-Umstrukturierung |
|
|
|
|
Beispiele:
|
|
- `Add: E-Mail-Anhänge unterstützen`
|
|
- `Fix: SMTP-Timeout bei langsamer Verbindung`
|
|
- `Docs: CID-Embedding Beispiele ergänzen`
|
|
|
|
## Lizenz
|
|
|
|
Mit deinem Beitrag stimmst du zu, dass dein Code unter der MIT-Lizenz veröffentlicht wird.
|