5 Ideen für einen verbesserten GitHub-Workflow
Abhängig von Ihrer Vorgeschichte mit funktionierender Quellcodeverwaltung variiert die Art und Weise, wie Sie mit einer Codebasis arbeiten, Commits vornehmen usw.
Je nachdem, ob Sie Git, Subversion, Mercurial usw. verwenden, bestimmen auch Sie, wie Sie Ihren Code verwalten.
Aber wenn Sie jemand sind, der mit Git arbeitet (was, wie ich weiß, viele Leute in WordPress fast täglich verwenden), gibt es einige kleine Dinge, die ich empfehle, um Änderungen zu verwalten, insbesondere mit einem Team überschaubarer.
Tipps für einen verbesserten GitHub-Workflow
1 Verpflichte dich nicht zum Meister
Master sollte speziell für produktionsbereiten und bereitstellungsfähigen Code verwendet werden. Es ist nicht dein Arbeitszweig, es ist nicht dein Arbeitszweig.
Im Allgemeinen werden hier alle Pull-Requests zusammengeführt.
2 Versuchen Sie, immer Branches zu erstellen
Wann immer Sie eine Sammlung von Aufgaben, Problemen oder Meilensteinen haben, erstellen Sie einen Zweig und stellen Sie sicher, dass alles, woran Sie arbeiten, miteinander verbunden ist. Beispielsweise möchten Sie in Ihren Pull-Requests keine Datenbank- und JavaScript-Arbeit ausführen.
3 Stapeln Sie Ihre Arbeit
Selbst wenn Sie ausschließlich an der Front-End-Arbeit arbeiten, müssen Sie diese möglicherweise in kleinere Zweige aufteilen. Es ermöglicht einfachere Codeüberprüfungen und bessere Pull – Anfragen.
4 Generieren Sie kleine PRs
Dies ist der vorherigen Überschrift sehr ähnlich, aber die Idee, kleine PRs zu erstellen, ist weitaus produktiver als das Erstellen längerer Pull-Requests.
- Dies hilft, wenn Sie eine Codeüberprüfung anfordern müssen, da es Ihren Teamkollegen eine einfachere Möglichkeit gibt, Codeüberprüfungen durchzuführen und Feedback zu geben.
- Es hält das Änderungsprotokoll schlank und hilft dabei, einen detaillierten Bericht darüber zu erstellen, was der jeweilige Code-Batch tut.
Doch was macht eine gute PR aus?
5 Geben Sie gute Details in Ihrer PR an
Soweit es mich betrifft, wird ein guter Pull-Request eine kleine Reihe von Dingen erledigen:
- Geben Sie in nur ein oder zwei Sätzen an, was die Person, die Ihre Änderungen überprüft, erwarten sollte.
- Verknüpfen Sie den PR mit dem Ticket, der Projektmanagementkarte (oder wie auch immer sie es in Ihrem System nennen),
- Listen Sie kürzere Versionen der Commit-Nachrichten auf, um es Ihrem Peer-Reviewer so einfach wie möglich zu machen.
Abgesehen davon gibt es wahrscheinlich noch mehr Dinge, die Sie tun können, aber dies sind die Dinge, die ich am nützlichsten fand (und ich muss sagen, dass ich einige dieser Dinge nicht von meinem Team gelernt habe ).
Gibt es noch mehr Dinge?
Stets.
Aber das sind ein paar Dinge, die ich als immer nützlicher empfunden habe, besonders beim Nachverfolgen von Änderungen, bei der Zusammenarbeit mit anderen und beim Umgang mit Pull-Requests (sowohl von denen, mit denen ich arbeite, als auch von denen, die zu Open-Source-Projekten beitragen).
Schließlich ist keines dieser Dinge vorgeschrieben. Es gibt eine Lernkurve (ich spreche aus Erfahrung), aber ich empfehle, einige davon auszuprobieren, wenn auch nur, um zu sehen, ob es Ihren Workflow nicht verbessert.
Auch wenn es nur ein bisschen ist.