An dieser Dokumentation mitwirken
Vielen Dank für Ihr Interesse an unserer Dokumentation!
- Mit GitHub mitwirken
- Mit Git mitwirken
- Verwenden von Markdown zum Formatieren Ihres Themas
- Markupkonventionen & Regeln speziell für dieses Repository
- Häufig gestellte Fragen
- Weitere Ressourcen
Verwenden Sie GitHub, um an dieser Dokumentation mitzuwirken, ohne dass Sie hierfür das Repo auf Ihrem Desktop klonen. Dies ist die einfachste Möglichkeit zum Erstellen einer Pullanforderung in diesem Repository. Verwenden Sie diese Methode, um eine kleinere Änderung vorzunehmen, mit der keine Codeänderungen einhergehen. Mit dieser Methode können Sie jeweils zu einem Artikel beitragen.
- Suchen Sie den Artikel, den Sie bei GitHub beisteuern möchten.
- Sobald Sie sich auf dem Artikel in GitHub befinden, melden Sie sich bei GitHub an (erhalten Sie ein kostenloses Konto bei GitHub).
- Wählen Sie das Stiftsymbol aus (bearbeiten Sie die Datei in Ihrem Fork dieses Projekts), und nehmen Sie ihre Änderungen im <>Fenster Datei bearbeiten vor.
- Führen Sie einen Bildlauf nach unten durch, und geben Sie eine Beschreibung ein.
- Wählen Sie Propose file change>Create pull request aus.
Sie haben nun erfolgreich eine Pullanforderung übermittelt. Pullanforderungen werden in der Regel innerhalb von 10 Werktagen bearbeitet.
Verwenden Sie Git, um umfangreiche Änderungen vorzunehmen, z. B.:
- Beisteuern von Code
- Beisteuern von Änderungen, die Auswirkungen auf die Bedeutung haben
- Beisteuern von umfangreichen Änderungen an Text
- Hinzufügen neuer Themen
Wenn Sie nicht über ein GitHub-Konto verfügen, richten Sie eines auf GitHub ein.
Nachdem Sie ein Konto erstellt haben, installieren Sie Git auf Ihrem Computer. Führen Sie die Schritte im Tutorial [Git einrichten] aus.
Um eine Pullanforderung mit Git zu übermitteln, führen Sie die Schritte unter Verwenden von GitHub, Git und diesem Repository durch.
Sie werden aufgefordert, den Lizenzvertrag des Mitwirkenden zu unterzeichnen, wenn Sie:
- Mitglied der Microsoft Open Technologies-Gruppe sind.
- Ein Mitwirkender, der nicht für Microsoft arbeitet.
Als Mitglied der Community müssen Sie den Lizenzvertrag für Mitwirkende (CLA) unterzeichnen, bevor Sie umfangreiche Beiträge zu einem Projekt leisten können. Sie müssen die Dokumentation nur einmal ausfüllen und übermitteln. Überprüfen Sie das Dokument sorgfältig. Möglicherweise muss Ihr Arbeitgeber das Dokument unterzeichnen.
Durch das Unterzeichnen des Lizenzvertrags für Mitwirkende (CLA) erhalten Sie keine Zugriffsrechte auf das Hauptrepository, aber es bedeutet, dass die Office Developer- und Office Developer Content Publishing-Teams in der Lage sind, Ihre Beiträge zu prüfen und überdenken. Ihre Übermittlungen werden Ihnen gutgeschrieben.
Pullanforderungen werden in der Regel innerhalb von 10 Werktagen bearbeitet.
Hinweis
Die meisten Informationen in diesem Abschnitt finden Sie in [GitHub-Hilfe]-Artikeln. Wenn Sie mit Git und GitHub vertraut sind, fahren Sie mit dem Abschnitt zum Einsenden und Bearbeiten von Inhalten mit speziellen Informationen zum Code-/Inhaltsfluss dieses Repositorys fort.
Richten Sie ein GitHub-Konto ein, damit Sie an diesem Projekt mitwirken können. Falls noch nicht geschehen, wechseln Sie zu GitHub, und richten Sie jetzt ein Konto ein.
Installieren Sie Git auf Ihrem Computer. Führen Sie die Schritte im Tutorial [Git einrichten] aus.
Erstellen Sie Ihre eigene Verzweigung dieses Repositorys. Wählen Sie dazu oben auf der Seite die Schaltfläche Fork aus.
Kopieren Sie die Verzweigung auf Ihren Computer. Öffnen Sie hierzu Git Bash. Geben Sie an der Eingabeaufforderung Folgendes ein:
git clone https://github.com/<your user name>/<repo name>.git
Erstellen Sie danach einen Verweis auf das Stammrepository durch Eingabe der folgenden Befehle:
cd <repo name>
git remote add upstream https://github.com/OfficeDev/<repo name>.git
git fetch upstream
Herzlichen Glückwunsch! Sie haben nun Ihr Repository eingerichtet. Sie müssen diese Schritte nicht erneut ausführen.
Um die Mitwirkung für Sie so einfach wie möglich zu machen, führen Sie die folgenden Schritte aus.
- Erstellen Sie eine neue Verzweigung.
- Fügen Sie neue Inhalte hinzu, oder bearbeiten Sie vorhandene Inhalte.
- Senden Sie eine Pull-Anforderung an das Hauptrepository.
- Löschen Sie die Verzweigung.
Wichtig: Beschränken Sie jeden Branch auf ein einzelnes Konzept/einen einzelnen Artikel, um den Workflow zu optimieren und die Wahrscheinlichkeit von Mergekonflikten zu verringern. Zu den für einen neuen Branch geeigneten Inhalten gehören:
- Ein neuer Artikel.
- Bearbeitung von Rechtschreibung und Grammatik.
- Vornehmen einer einzelnen Formatierungsänderung für eine große Gruppe von Artikeln (z. B. Übernehmen einer neuen Copyright-Fußzeile).
- Öffnen Sie Git Bash.
- Geben Sie an der Git Bash-Eingabeaufforderung
git pull upstream main:<new branch name>
ein. Dadurch wird lokal ein neuer Branch erstellt, der aus dem neuesten OfficeDev-Standard-Branch kopiert wird. - Geben Sie an der Git Bash-Eingabeaufforderung
git push origin <new branch name>
ein. Dadurch wird GitHub auf die neue Verzweigung hingewiesen. Die neue Verzweigung sollte nun in Ihrer Verzweigung des Repository auf GitHub angezeigt werden. - Geben Sie in der Git Bash-Befehlszeile
git checkout <new branch name>
ein, um zu Ihrer neuen Verzweigung umzuschalten.
Sie navigieren mithilfe des Datei-Explorers zu dem Repository auf dem Computer. Die Repositorydateien befinden sich in C:\Users\<yourusername>\<repo name>
.
Zum Bearbeiten von Dateien öffnen Sie sie in einem Editor Ihrer Wahl und ändern sie. Um eine neue Datei zu erstellen, verwenden Sie den Editor Ihrer Wahl, und speichern Sie die neue Datei im entsprechenden Speicherort in Ihrer lokalen Kopie des Repositorys. Speichern Sie während der Bearbeitung häufig.
Die Dateien in C:\Users\<yourusername>\<repo name>
sind eine Arbeitskopie der neuen Verzweigung, die Sie in Ihrem lokalen Repository erstellt haben. Änderungen in diesem Ordner wirken sich erst auf das lokale Repository aus, wenn Sie eine Änderung übernehmen. Um eine Änderung am lokalen Repository zu übernehmen, geben Sie die folgenden Befehle in GitBash ein:
git add .
git commit -v -a -m "<Describe the changes made in this commit>"
Der add
-Befehl fügt Ihre Änderungen einem Stagingbereich als Vorbereitung für die Aufnahme im Repository hinzu. Der Punkt nach dem add
-Befehl gibt an, dass Sie alle Dateien, die Sie hinzugefügt oder geändert haben, übernehmen möchten und dass Unterordner rekursiv überprüft werden sollen. (Wenn Sie nicht alle Änderungen committen möchten, können Sie bestimmte Dateien hinzufügen. Sie können einen Commit auch rückgängigmachen. Wenn Sie Hilfe benötigen, geben Sie git add -help
oder ein git status
.
Der Befehl commit
wendet die bereitgestellten Änderungen auf das Repository an. Der Schalter -m
bedeutet, dass Sie den Commit-Kommentar in der Befehlszeile angeben. Die Optionen -v und -a können weggelassen werden. Die Option -v ist für die ausführliche Ausgabe des Befehls, und -a entspricht in ihrer Funktion den bereits verwendeten Befehl zum Hinzufügen.
Sie können während der Arbeit mehrfach übernehmen oder warten und erst nach Abschluss der Arbeit übernehmen.
Wenn Sie Ihre Arbeit abgeschlossen haben und bereit sind, sie mit dem zentralen Repository zusammenzuführen, gehen Sie folgendermaßen vor.
- Geben Sie an der Git Bash-Eingabeaufforderung
git push origin <new branch name>
ein. Im lokalen Repository bezieht sichorigin
auf Ihr GitHub-Repository, aus dem Sie das lokale Repository geklont haben. Mit diesem Befehl wird der aktuelle Status Ihrer neuen Verzweigung, einschließlich aller im vorherigen Schritt vorgenommenen Commits, in Ihre GitHub-Verzweigung übertragen. - Navigieren Sie auf der GitHub-Website in Ihrer Verzweigung zur neuen Verzweigung.
- Klicken Sie oben auf der Seite auf die Schaltfläche Pullanforderung.
- Stellen Sie sicher, dass die untere Verzweigung
OfficeDev/<repo name>@main
und die obere Verzweigung<your username>/<repo name>@<branch name>
lautet. - Klicken Sie auf die Schaltfläche Commitbereich aktualisieren.
- Geben Sie Ihrer Pullanforderung einen Titel, und beschreiben Sie alle Änderungen, die Sie vornehmen.
- Senden Sie die Pullanforderung.
Einer der Websiteadministratoren wird nun Ihre Pullanforderung verarbeiten. Ihr Pull Request wird auf der Website OfficeDev/Repositoryname unter Probleme angezeigt. Wenn die Pullanforderung angenommen wird, wird das Problem gelöst.
Nachdem ein Branch erfolgreich zusammengeführt wurde (d. h. Ihr Pull Request wird akzeptiert), arbeiten Sie nicht mehr in diesem lokalen Branch. Dies kann zu Mergekonflikten führen, wenn Sie einen anderen Pull Request übermitteln. Um ein weiteres Update durchzuführen, erstellen Sie einen neuen lokalen Branch aus dem erfolgreich zusammengeführten Upstreambranch, und löschen Sie dann Ihren ursprünglichen lokalen Branch.
Wenn Ihr lokaler Branch X beispielsweise erfolgreich mit dem Standard Branch OfficeDev/microsoft-graph-docs zusammengeführt wurde und Sie zusätzliche Aktualisierungen an den zusammengeführten Inhalten vornehmen möchten. Erstellen Sie eine neue lokale Verzweigung X2 aus der officeDev/microsoft-graph-docs Standard Branch. Öffnen Sie dazu GitBash, und führen Sie die folgenden Befehle aus:
cd microsoft-graph-docs
git pull upstream main:X2
git push origin X2
Sie verfügen jetzt über lokale Kopien (in einem neuen lokalen Branch) der Arbeit, die Sie in Branch X übermittelt haben. Der X2-Branch enthält auch alle Arbeiten, die andere Autoren zusammengeführt haben. Wenn Ihre Arbeit also von der Arbeit anderer abhängt (z. B. freigegebene Images), ist sie im neuen Branch verfügbar. Sie können überprüfen, ob sich Ihre vorherige Arbeit (und die Arbeit anderer) in der Verzweigung befindet, indem Sie den neuen Branch...
git checkout X2
... und den Inhalt verifizieren. (Der checkout
Befehl aktualisiert die Dateien in auf C:\Users\<yourusername>\microsoft-graph-docs
den aktuellen Zustand der X2-Verzweigung.) Nachdem Sie den neuen Branch ausgecheckt haben, können Sie Aktualisierungen am Inhalt vornehmen und sie wie gewohnt committen. Um aber zu vermeiden, dass Sie versehentlich in der zusammengeführten Verzweigung (X) arbeiten, empfiehlt es sich, sie zu löschen (Informationen finden Sie im folgenden Abschnitt Löschen einer Verzweigung).
Nachdem Ihre Änderungen erfolgreich mit dem Hauptrepository zusammengeführt wurden, können Sie die verwendete Verzweigung löschen, da Sie sie nicht mehr benötigen. Zusätzliche Aufgaben sollten in einer neuen Verzweigung vorgenommen werden.
- Geben Sie an der Git Bash-Eingabeaufforderung
git checkout main
ein. Dadurch wird sichergestellt, dass Sie sich nicht in der zu löschenden Verzweigung befinden (das ist nicht zulässig). - Geben Sie als Nächstes an der Eingabeaufforderung ein
git branch -d <branch name>
. Dadurch wird der Branch auf Ihrem Computer nur gelöscht, wenn er erfolgreich mit dem Upstream-Repository zusammengeführt wurde. (Sie können dieses Verhalten mit dem–D
-Flag außer Kraft setzen, allerdings sollten Sie sich in diesem Falle wirklich sicher sein.) - Geben Sie schließlich
git push origin :<branch name>
an der Befehlszeile ein (ein Leerzeichen vor dem Doppelpunkt, kein Leerzeichen dahinter). Dadurch wird die Verzweigung in Ihrer Github-Verzweigung gelöscht.
Herzlichen Glückwunsch, Sie haben erfolgreich am Projekt mitgewirkt.
Alle Artikel in diesem Repository verwenden Markdown. Eine vollständige Einführung (und Auflistung der gesamten Syntax) finden Sie unter [Daring Fireball - Markdown].
Weitere Informationen finden Sie in der Markdownreferenz zur Dokumentation in unserem Mitwirkender Leitfaden.
Füllen Sie das Formular auf der Seite Join GitHub aus, um ein kostenloses GitHub-Konto zu eröffnen.
Sie erhalten automatisch eine Benachrichtigung, dass Sie den Lizenzvertrag des Mitwirkenden (CLA) unterzeichnen müssen, wenn Ihr Pull Request einen erfordert.
Als Mitglied der Community müssen Sie den Lizenzvertrag für Mitwirkende (CLA) unterzeichnen, bevor Sie umfangreiche Beiträge zu diesem Projekt leisten können. Sie müssen die Dokumentation nur einmal ausfüllen und übermitteln. Überprüfen Sie das Dokument sorgfältig. Möglicherweise muss Ihr Arbeitgeber das Dokument unterzeichnen.
Wenn Sie Ihre Änderungen über einen Pull Request übermitteln, wird unser Team benachrichtigt und überprüft Ihren Pull Request. Sie erhalten Benachrichtigungen zu Ihrem Pull Request von GitHub. Sie können auch von jemandem aus unserem Team benachrichtigt werden, wenn wir weitere Informationen benötigen. Wenn Ihr Pull Request genehmigt wurde, aktualisieren wir die Dokumentation. Wir behalten uns das Recht vor, Ihre Übermittlung aus rechtlichen Gründen, Stil, Klarheit oder anderen Fragen zu bearbeiten.
Derzeit können externe Mitwirkende keine Pullanforderungen in diesem Repository genehmigen.
Pullanforderungen werden in der Regel innerhalb von 10 Werktagen bearbeitet.
- Weitere Informationen zu Markdown finden Sie auf der Website des Markdown-Erstellers [Daring Fireball].
- Weitere Informationen zur Verwendung von Git und GitHub finden Sie in der [GitHub-Hilfe].
GitHub HomeGitHub HelpSetup up GitDaring Fireball – MarkdownDaring Fireball