2012-05-17 8 views
97

Ich habe eine Wiki-Seite unter GitHub gesehen, die nicht bearbeitet werden kann. Dann gab ich das Projekt ab, bearbeitete es auf "Mein Ende" und versuchte eine Pull-Anfrage zu machen. Es stellt sich heraus, dass das Wiki nicht im Projekt ist, und es gibt keine Möglichkeit, Änderungen daran zu übergeben.Wie kann ich eine Wiki-Seite auf GitHub anfordern?

Kann ich anders als per E-Mail fortfahren, wenn ich in diesem Fall eine Änderung im Wiki vorschlagen möchte?

An dieser Stelle habe ich herausgefunden, was seems like an alternative unter "Fragen mit ähnlichen Titeln", aber ich konnte die Pull-Anfrage damit noch nicht tun, und ich bin mir nicht sicher, Submodulen ist ein guter Weg für diesen Zweck. Ich sehe jetzt, ich könnte es wahrscheinlich irgendwie verzweigen ... Also ist das der Weg zu gehen?

+3

Berichtet auf https://github.com/isaacs/github/issues/846 –

+0

Ich weiß, ich bin zu spät zur Party auf diesem, aber ich denke mit dem '.wiki' Git Repo als Submodul der Das Hauptprojekt Repo scheint der beste Ansatz für diese Situation zu sein. – Chris

Antwort

81

GitHub doesn't support pull requests for the wiki repository, nur das Haupt-Repository (das ist ein bisschen eine Schande, IMO, aber ich kann es verstehen).

Hier ist eine interessante Möglichkeit, eine Projektgemeinschaft Aktuelles zu ihrem Wiki verwaltet, während immer noch eine strenge Kontrolle zu halten, wie es für den Quellcode:

Mein vorgeschlagenen Workflow ist dies:

  1. Erstellen Sie manuell eine Gabel des Taffy-Wikis auf Ihrem Github-Konto:
    • Erstellen Sie ein neues Repository auf Ihrem GitHub-Konto. Nennen wir es "Taffy-Wiki".
    • Clone der Taffy Wiki-Repo auf den lokalen Rechner irgendwo: git clone [email protected]:atuttle/Taffy.wiki.git
    • das Original "Ursprung" remote entfernen und Ihre GitHub Repo als neue "Ursprung" git remote rm origin und git remote add origin [email protected]:<YOUR_USERNAME>/Taffy-Wiki.git hinzufügen
  2. Machen Sie Ihre vorgeschlagenen Änderungen vor Ort, dann schieb sie sie zu ihrem github konto: git push -u origin master ('-u origin master' benötigt nur das erste mal; danach einfach tun git push)
  3. Ein Ticket an den offiziellen Taffy-Issue-Tracker senden und mich bitten, deine Änderungen zu überprüfen und sie zusammenzuführen. Bitte geben Sie einen Link zu Ihrem Repo an und beschreiben Sie, was Sie geändert haben.
  4. Goto # 2

(Von How you can contribute to Taffy documentation.)

Wenn es nach mir ginge, würde ich ein Problem im Haupt-Repository erstellen (das heißt, diejenige, die Sie gegabelt) schlägt eine Aktualisierung des Wikis vor. Wenn Probleme nicht aktiviert sind, dann E-Mails über die einzige andere Option, die ich mir vorstellen kann.

+0

Über Ihre Antwort, sind diese Konsolenbefehle für Git Bash? –

+0

@ Chi-YoungJeffreyLii Diese Befehle sind nicht meine, sondern stammen aus dem Blogbeitrag, den ich zitiert habe (ich habe die Quelle unter dem Zitat verlinkt). Das sind Command-Line-Git-Befehle, die auf jeder Plattform mit Git funktionieren sollten, einschließlich Windows, einschließlich eines UNIX- oder GNU/Linux-Betriebssystems mit der Bash-Shell. – Calrion

0

Wenn Sie in Ordnung sind, ein einseitiges langes Dokument zu haben (ich mag es eigentlich mehr), können Sie die README.MD entführen und den Inhalt des Wikis dorthin stellen.

Nicht nur wird es als Teil des normalen Repository verfolgt, es wird auch auf der Homepage angezeigt.

Es kann gemacht werden, um mit einer Kurzreferenz anzufangen und dann in eine detailliertere Beschreibung/Anweisungen zu gelangen, so dass die normalen Benutzer zuerst die allgemeineren Informationen treffen werden.

Verwandte Themen