So erstellen Sie GitHub-Issues 5-mal schneller

GitHub-Probleme sind fantastisch, um neue Funktionen oder Fehler zu verfolgen, wer zugewiesen ist, sie zu kategorisieren, zu Projekten hinzuzufügen und so weiter. Gleichzeitig sind sie auch ziemlich langsam zu erstellen, und das Erstellen einer Reihe von ihnen nimmt zu viel Zeit in Anspruch.

Einer der Schwachpunkte, die ich bei GitHub- Problemen bei der Arbeit sehe, ist, dass sie umständlich zu erstellen sind, insbesondere für diejenigen, die keine Entwickler oder Designer sind, wie Manager oder Tester, die einen Fehler melden möchten, ohne den Prozess der Erstellung durchlaufen zu müssen auf GitHub.

Vor einiger Zeit schrieb ich über eine App, die ich schrieb, um die Erstellung von GitHub-Problemen zu beschleunigen. Eigentlich habe ich die App gebaut, aber dann habe ich vergessen, hier darüber zu schreiben, also hier der richtige Blogbeitrag. In diesem Beitrag werden wir sehen:

2. Schreiben einer Reihe von GitHub-Problemen mit Klartext
3. Der Tech-Stack hinter der App
4. Weitere Ideen zur Verbesserung der Problemerstellung

Warum eine App, um GitHub-Issues schneller zu erstellen?

Die GitHub-Benutzeroberfläche ist normalerweise in Ordnung, um ein Problem zu erstellen. Oder zwei. Und es ist in Ordnung für technisch versierte Leute wie Entwickler oder Designer. In unserem Unternehmen Reconnect bitten wir jedoch manchmal, nachdem wir eine neue Funktion entwickelt haben, unsere nicht-technischen Mitarbeiter, sie zu testen. Und das funktioniert großartig, weil sie normalerweise einige Probleme finden. Aber es ist sehr aufwendig für sie, durch die GitHub-Issues-Benutzeroberfläche zu springen. Dies ist noch umständlicher, wenn sie mehr als ein Problem und wahrscheinlich in verschiedenen Repositories erstellen müssen.

Wenn wir quantifizieren, wie oft wir unsere Aufmerksamkeit darauf lenken, GitHub -Issues zu erstellen, sobald wir die Seite erreicht haben, um ein Issue in dem Repository zu erstellen, in dem wir sie erstellen möchten, wäre es ungefähr so:

• geben Sie den Titel ein
• Gehen Sie zum Textfeld des Problems, um die Beschreibung einzugeben
• Gehen Sie zur Seitenleiste, um das Problem jemandem zuzuweisen
• Gehen Sie zum Labels-Block in der Seitenleiste, um ein Label hinzuzufügen
• Gehen Sie und klicken Sie auf die Schaltfläche, um das Problem tatsächlich zu erstellen

Das sind 5 Mal, wenn wir unsere Aufmerksamkeit von Bereich zu Bereich lenken! Zu viel Aufmerksamkeitsverlagerung für eine Aufgabe, die im Wesentlichen das Schreiben ist, und zu viel Zeit damit verbracht, sich neu zu konzentrieren. Und was ist, wenn Sie ein Issue in einem anderen Repository schreiben müssen? Sie müssen in einem neuen Tab oder im aktuellen Tab zu diesem Repository navigieren, und das ist mehr verlorene Zeit.

Wie können Sie also GitHub-Issues einfacher und schneller erstellen? Wäre es nicht einfacher, wenn wir uns auf einen einzigen Ort konzentrieren könnten, ohne unsere Aufmerksamkeit mehrmals verlagern zu müssen?

Schreiben einer Reihe von GitHub-Problemen mit Klartext

Schreiben ist eine der grundlegendsten Fähigkeiten in Geräten, es ist grundlegender als sogar Berührungsgesten. Denn während diese spezifisch für Touch-Geräte sind, müssen Sie bei anderen eine Maus oder ein Trackpad verwenden. Aber Schreiben ist meistens immer gleich. Und GitHub-Probleme sind Text. Warum also nicht Text verwenden, um sie zu erstellen, ohne jemals unsere Tastatur zu verlassen?

Diese App macht genau das: https://fast-issues.herokuapp.com/

Sie autorisieren diese GitHub-App und können mit dem Schreiben von Issues in all Ihren Repositories beginnen. Sie müssen nur ein Repository auswählen, in dem Sie ein Problem erstellen möchten, und mit dem Schreiben mehrerer Probleme beginnen, eines in jeder Zeile.

Und es unterstützt das Schreiben des Titels und der Beschreibung, das Zuweisen und Beschriften. Es wird nur der Titel des Problems benötigt. Der Rest ist alles optional. Sie müssen nur eine bestimmte Konvention befolgen:

• der Titel steht an erster Stelle
• dann trennt ein Pipe-Zeichen die Bevollmächtigten. Ich habe es so gewählt, weil man zumindest ein Problem und jemanden braucht, der daran arbeitet
• ein zweiter senkrechter Strich trennt die Problembeschreibung. Es kann beliebig lang sein, darf aber keine Zeilenumbrüche haben, da dies ein neues Problem auslösen würde
• ein drittes Pipe-Zeichen trennt die Labels

Es unterstützt mehrere Beauftragte und Bezeichnungen, indem sie durch ein Komma getrennt werden. Also im Prinzip:

This is the title | username1, username2 | This is the issue description, as long as you want it but without line breaks. | Label 1, Label 2<br>This is another issue | username3 | And another issue description | Bug

Sobald es fertig ist, müssen Sie nur noch auf Go! Schaltfläche und es werden alle Probleme erstellt. Jeder hat Sie als Autor. Sie können sie später bearbeiten, um Bilder oder Videos, Memes usw. hinzuzufügen.

Wenn Sie weitere Issues in einem anderen Repository erstellen müssen, wählen Sie es einfach erneut aus der Dropdown-Liste aus und beginnen Sie mit dem Schreiben dieser Issues. Kein Springen mehr durch Seiten!

Der Tech-Stack hinter der App

Das Repository für diese App befindet sich unter https://github.com/eliorivero/fast-issues

Der Tech-Stack ist besonders einfach und basiert vollständig auf JavaScript :

• Frontend mit React erstellt
• mit Node.js erstelltes Backend
• verwendet Express als Server
• und Octokit REST, eine Bibliothek zur Arbeit mit der GitHub-API

Beachten Sie, dass wir die von der GitHub-Issues-API zugelassenen Anforderungen nicht überschreiten möchten. Sie empfehlen, zwischen den Anfragen mindestens eine Sekunde vergehen zu lassen, also habe ich die Ausführung 1,5 Sekunden zwischen der Erstellung jedes Problems angehalten.

Vom anfänglichen Prototyp, den ich erstellt habe, bis zur endgültigen Version habe ich sie von einer GitHub-App in eine OAuth-App geändert. Dies liegt daran, dass Sie mit letzterem Ausgaben erstellen und als Autor auftreten können.

Weitere Ideen zur Verbesserung der Problemerstellung

Ich zeigte dies einem Freund und er erzählte mir, dass er diese Idee hatte, eine Chrome-Erweiterung zu erstellen, um einen Screenshot eines Fehlers zu machen, ihn zu kommentieren und ihn als GitHub-Problem einzureichen. Ich fand es eine großartige Idee, also suchte ich nach einer Möglichkeit, einen Screenshot zu machen, aber in einer React-App fand ich schnell html2canvas, das es erlaubt, Screenshots zu machen und sie als PNG-Dateien zu speichern.

Die Kombination von so etwas mit meinem Tool zum Erstellen der Probleme wäre eine nette Lösung, die in einer React-App während ihres Entwicklungs- oder Staging-Zyklus verfügbar sein könnte. Jeder, der die App testet, kann das Problemmeldefeld auslösen und ein GitHub-Problem einreichen.

Das einzige Problem dabei ist vorerst, dass die GitHub-API das Hochladen von Bildern nicht zulässt, daher müssten sie woanders gehostet und der Link zu diesem Ort in dieses Tool eingefügt werden, aber es ist definitiv eine gute Verbesserung.

Also noch einmal, die App ist unter https://fast-issues.herokuapp.com/ und wenn Sie sie am Ende verwenden, lassen Sie es mich in den Kommentaren wissen.