12 KiB

Raw Blame History

Beitrag zu Data Science für Anfänger

Vielen Dank für Ihr Interesse, zum Lehrplan "Data Science für Anfänger" beizutragen! Wir freuen uns über Beiträge aus der Community.

Inhaltsverzeichnis

Verhaltenskodex

Dieses Projekt hat den Microsoft Open Source Code of Conduct übernommen.
Weitere Informationen finden Sie in den Code of Conduct FAQ
oder kontaktieren Sie opencode@microsoft.com bei weiteren Fragen oder Kommentaren.

Wie kann ich beitragen?

Fehler melden

Bevor Sie Fehlerberichte erstellen, überprüfen Sie bitte die vorhandenen Issues, um Duplikate zu vermeiden. Wenn Sie einen Fehler melden, geben Sie so viele Details wie möglich an:

Verwenden Sie einen klaren und beschreibenden Titel
Beschreiben Sie die genauen Schritte, um das Problem zu reproduzieren
Geben Sie konkrete Beispiele an (Code-Snippets, Screenshots)
Beschreiben Sie das beobachtete Verhalten und was Sie erwartet haben
Fügen Sie Details zu Ihrer Umgebung hinzu (Betriebssystem, Python-Version, Browser)

Verbesserungsvorschläge

Vorschläge zur Verbesserung sind willkommen! Wenn Sie Verbesserungen vorschlagen:

Verwenden Sie einen klaren und beschreibenden Titel
Geben Sie eine detaillierte Beschreibung der vorgeschlagenen Verbesserung
Erklären Sie, warum diese Verbesserung nützlich wäre
Listen Sie ähnliche Funktionen in anderen Projekten auf, falls zutreffend

Beitrag zur Dokumentation

Verbesserungen der Dokumentation sind immer willkommen:

Korrigieren Sie Rechtschreib- und Grammatikfehler
Verbessern Sie die Klarheit von Erklärungen
Fügen Sie fehlende Dokumentation hinzu
Aktualisieren Sie veraltete Informationen
Fügen Sie Beispiele oder Anwendungsfälle hinzu

Beitrag zum Code

Wir freuen uns über Code-Beiträge, einschließlich:

Neue Lektionen oder Übungen
Fehlerbehebungen
Verbesserungen an bestehenden Notebooks
Neue Datensätze oder Beispiele
Erweiterungen der Quiz-Anwendung

Erste Schritte

Voraussetzungen

Bevor Sie beitragen, stellen Sie sicher, dass Sie Folgendes haben:

Ein GitHub-Konto
Git auf Ihrem System installiert
Python 3.7+ und Jupyter installiert
Node.js und npm (für Beiträge zur Quiz-App)
Vertrautheit mit der Struktur des Lehrplans

Siehe INSTALLATION.md für detaillierte Installationsanweisungen.

Fork und Klonen

Forken Sie das Repository auf GitHub

Klonen Sie Ihren Fork lokal:

git clone https://github.com/YOUR-USERNAME/Data-Science-For-Beginners.git
cd Data-Science-For-Beginners

Fügen Sie das Upstream-Remote hinzu:

git remote add upstream https://github.com/microsoft/Data-Science-For-Beginners.git

Erstellen eines Branches

Erstellen Sie einen neuen Branch für Ihre Arbeit:

git checkout -b feature/your-feature-name
# or
git checkout -b fix/your-bug-fix

Branch-Namenskonventionen:

feature/ - Neue Funktionen oder Lektionen
fix/ - Fehlerbehebungen
docs/ - Änderungen an der Dokumentation
refactor/ - Code-Refaktorierung

Richtlinien für Beiträge

Für Lektionen

Wenn Sie Lektionen beitragen oder bestehende ändern:

Folgen Sie der bestehenden Struktur:
- README.md mit Lektioneninhalt
- Jupyter-Notebook mit Übungen
- Aufgabe (falls zutreffend)
- Link zu Vor- und Nachtests
Fügen Sie diese Elemente hinzu:
- Klare Lernziele
- Schritt-für-Schritt-Erklärungen
- Code-Beispiele mit Kommentaren
- Übungen zum Üben
- Links zu zusätzlichen Ressourcen
Stellen Sie Barrierefreiheit sicher:
- Verwenden Sie klare, einfache Sprache
- Geben Sie Alt-Text für Bilder an
- Fügen Sie Code-Kommentare hinzu
- Berücksichtigen Sie unterschiedliche Lernstile

Für Jupyter-Notebooks

Löschen Sie alle Ausgaben, bevor Sie Änderungen einreichen:
```
jupyter nbconvert --clear-output --inplace notebook.ipynb
```
Fügen Sie Markdown-Zellen mit Erklärungen hinzu

Verwenden Sie einheitliche Formatierung:

# Import libraries at the top
import pandas as pd
import numpy as np
import matplotlib.pyplot as plt

# Use meaningful variable names
# Add comments for complex operations
# Follow PEP 8 style guidelines

Testen Sie Ihr Notebook vollständig, bevor Sie es einreichen

Für Python-Code

Befolgen Sie die PEP 8 Stilrichtlinien:

# Good practices
import pandas as pd

def calculate_mean(data):
    """Calculate the mean of a dataset.
    
    Args:
        data (list): List of numerical values
        
    Returns:
        float: Mean of the dataset
    """
    return sum(data) / len(data)

Für Beiträge zur Quiz-App

Wenn Sie die Quiz-Anwendung ändern:

Testen Sie lokal:
```
cd quiz-app
npm install
npm run serve
```
Führen Sie den Linter aus:
```
npm run lint
```
Erfolgreich bauen:
```
npm run build
```
Befolgen Sie die Vue.js-Stilrichtlinien und bestehende Muster

Für Übersetzungen

Wenn Sie Übersetzungen hinzufügen oder aktualisieren:

Folgen Sie der Struktur im translations/-Ordner
Verwenden Sie den Sprachcode als Ordnernamen (z. B. fr für Französisch)
Behalten Sie die gleiche Dateistruktur wie die englische Version bei
Aktualisieren Sie Quiz-Links, um den Sprachparameter einzuschließen: ?loc=fr
Testen Sie alle Links und die Formatierung

Ablauf für Pull Requests

Vor dem Einreichen

Aktualisieren Sie Ihren Branch mit den neuesten Änderungen:
```
git fetch upstream
git rebase upstream/main
```
Testen Sie Ihre Änderungen:
- Führen Sie alle geänderten Notebooks aus
- Testen Sie die Quiz-App, falls geändert
- Überprüfen Sie, ob alle Links funktionieren
- Prüfen Sie auf Rechtschreib- und Grammatikfehler
Committen Sie Ihre Änderungen:
```
git add .
git commit -m "Brief description of changes"
```
Schreiben Sie klare Commit-Nachrichten:
- Verwenden Sie die Gegenwartsform ("Füge Funktion hinzu" statt "Funktion hinzugefügt")
- Verwenden Sie den Imperativ ("Bewege Cursor zu..." statt "Bewegt Cursor zu...")
- Begrenzen Sie die erste Zeile auf 72 Zeichen
- Verweisen Sie auf Issues und Pull Requests, wenn relevant

Pushen Sie zu Ihrem Fork:

git push origin feature/your-feature-name

Erstellen des Pull Requests

Gehen Sie zum Repository
Klicken Sie auf "Pull requests" → "New pull request"
Klicken Sie auf "compare across forks"
Wählen Sie Ihren Fork und Branch aus
Klicken Sie auf "Create pull request"

Format des PR-Titels

Verwenden Sie klare, beschreibende Titel nach diesem Format:

[Component] Brief description

Beispiele:

[Lesson 7] Fix Python notebook import error
[Quiz App] Add German translation
[Docs] Update README with new prerequisites
[Fix] Correct data path in visualization lesson

PR-Beschreibung

Fügen Sie Ihrer PR-Beschreibung Folgendes hinzu:

Was: Welche Änderungen haben Sie vorgenommen?
Warum: Warum sind diese Änderungen notwendig?
Wie: Wie haben Sie die Änderungen implementiert?
Tests: Wie haben Sie die Änderungen getestet?
Screenshots: Fügen Sie Screenshots für visuelle Änderungen hinzu
Verwandte Issues: Verlinken Sie verwandte Issues (z. B. "Fixes #123")

Überprüfungsprozess

Automatische Checks werden für Ihre PR ausgeführt
Maintainer überprüfen Ihren Beitrag
Feedback bearbeiten durch zusätzliche Commits
Nach Genehmigung wird Ihre PR von einem Maintainer gemergt

Nach dem Merge Ihrer PR

Löschen Sie Ihren Branch:

git branch -d feature/your-feature-name
git push origin --delete feature/your-feature-name

Aktualisieren Sie Ihren Fork:

git checkout main
git pull upstream main
git push origin main

Stilrichtlinien

Markdown

Verwenden Sie konsistente Überschriftenebenen
Fügen Sie Leerzeilen zwischen Abschnitten ein
Verwenden Sie Code-Blöcke mit Sprachspezifikatoren:
```
```python
import pandas as pd
```
```
Fügen Sie Alt-Text zu Bildern hinzu: ![Alt-Text](../../translated_images/de/image.4ee84a82b5e4c9e6651b13fd27dcf615e427ec584929f2cef7167aa99151a77a.png)
Halten Sie die Zeilenlänge vernünftig (ca. 80-100 Zeichen)

Python

Befolgen Sie die PEP 8 Stilrichtlinien
Verwenden Sie aussagekräftige Variablennamen
Fügen Sie Docstrings zu Funktionen hinzu

Fügen Sie Typ-Hinweise hinzu, wo angebracht:

def process_data(df: pd.DataFrame) -> pd.DataFrame:
    """Process the input dataframe."""
    return df

JavaScript/Vue.js

Befolgen Sie die Vue.js 2 Stilrichtlinien
Verwenden Sie die bereitgestellte ESLint-Konfiguration
Schreiben Sie modulare, wiederverwendbare Komponenten
Fügen Sie Kommentare für komplexe Logik hinzu

Dateiorganisation

Halten Sie zusammengehörige Dateien zusammen
Verwenden Sie beschreibende Dateinamen
Folgen Sie der bestehenden Verzeichnisstruktur
Committen Sie keine unnötigen Dateien (.DS_Store, .pyc, node_modules, etc.)

Contributor License Agreement

Dieses Projekt begrüßt Beiträge und Vorschläge. Die meisten Beiträge erfordern, dass Sie einer Contributor License Agreement (CLA) zustimmen, die erklärt, dass Sie das Recht haben und tatsächlich die Rechte gewähren, Ihren Beitrag zu nutzen. Weitere Details finden Sie unter
https://cla.microsoft.com.

Wenn Sie einen Pull Request einreichen, wird ein CLA-Bot automatisch feststellen, ob Sie eine CLA bereitstellen müssen, und den PR entsprechend kennzeichnen (z. B. Label, Kommentar). Folgen Sie einfach den Anweisungen des Bots. Sie müssen dies nur einmal für alle Repositories tun, die unsere CLA verwenden.

Fragen?

Besuchen Sie unseren Discord-Kanal #data-science-for-beginners
Treten Sie unserer Discord-Community bei
Überprüfen Sie vorhandene Issues und Pull Requests

Vielen Dank!

Ihre Beiträge machen diesen Lehrplan für alle besser. Vielen Dank, dass Sie sich die Zeit nehmen, beizutragen!

Haftungsausschluss:
Dieses Dokument wurde mit dem KI-Übersetzungsdienst Co-op Translator übersetzt. Obwohl wir uns um Genauigkeit bemühen, beachten Sie bitte, dass automatisierte Übersetzungen Fehler oder Ungenauigkeiten enthalten können. Das Originaldokument in seiner ursprünglichen Sprache sollte als maßgebliche Quelle betrachtet werden. Für kritische Informationen wird eine professionelle menschliche Übersetzung empfohlen. Wir übernehmen keine Haftung für Missverständnisse oder Fehlinterpretationen, die sich aus der Nutzung dieser Übersetzung ergeben.

12 KiB Raw Blame History