Zum Hauptinhalt springen

Beitragen

Vielen Dank für Ihr Interesse, zu Exeoflow beizutragen!

Code of Conduct​

Bitte befolgen Sie unseren Code of Conduct.

Wie kann ich beitragen?​

Bug-Reports​

  1. Prüfen Sie, ob der Bug bereits gemeldet wurde
  2. Erstellen Sie ein Issue mit detaillierten Informationen
  3. Fügen Sie Schritte zur Reproduktion hinzu

Feature-Requests​

  1. Prüfen Sie bestehende Feature-Requests
  2. Beschreiben Sie den Use Case
  3. Erklären Sie den erwarteten Nutzen

Code-Beiträge​

Repository forken​

git clone https://github.com/IHR_USERNAME/exeoflow.git
cd exeoflow

Branch erstellen​

git checkout -b feature/mein-feature

Branch-Naming:

  • feature/ - Neue Features
  • fix/ - Bugfixes
  • docs/ - Dokumentation
  • refactor/ - Code-Refactoring

Code schreiben​

Befolgen Sie unsere Coding-Standards:

  • TypeScript verwenden
  • ESLint-Regeln befolgen
  • Tests schreiben
  • Code dokumentieren

Tests ausführen​

npm run test
npm run lint

Commit erstellen​

Wir verwenden Conventional Commits:

git commit -m "feat: Neue Funktion hinzugefügt"
git commit -m "fix: Bug behoben"
git commit -m "docs: Dokumentation aktualisiert"

Pull Request erstellen​

  1. Pushen Sie Ihren Branch
  2. Erstellen Sie einen Pull Request
  3. Beschreiben Sie Ihre Änderungen
  4. Verlinken Sie relevante Issues

Coding-Standards​

TypeScript​

// Typen verwenden
function processData(data: string): number {
  return data.length;
}

// Interfaces definieren
interface User {
  id: string;
  name: string;
}

Naming-Konventionen​

  • Variablen: camelCase
  • Klassen: PascalCase
  • Konstanten: UPPER_SNAKE_CASE
  • Dateien: kebab-case

Code-Formatierung​

npm run format

Review-Prozess​

  1. Automatische Tests laufen
  2. Code-Review durch Maintainer
  3. Änderungen einarbeiten
  4. Merge nach Approval

Lizenz​

Alle Beiträge werden unter der MIT-Lizenz veröffentlicht.