Beschleunigen Sie die Erstellung von GitHub-Problemen
GitHub-Probleme sind fantastisch, um neue Funktionen oder Fehler zu verfolgen, wer zugewiesen ist, sie zu kategorisieren, zu Projekten hinzuzufügen und so weiter. Sie sind auch ziemlich langsam zu erstellen, und das Erstellen einer Reihe von ihnen dauert viel zu lange. Also habe ich ein kleines Tool entwickelt, um die Problemerstellung zu beschleunigen und es zum Kinderspiel zu machen.
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 sind, wie Manager, Designer oder Tester, und die einfach einen Fehler melden möchten, es aber nicht tun den Prozess ihrer Erstellung auf GitHub.
Das Erstellen von GitHub-Problemen sollte schnell gehen
Was ist also die einfachste Interaktion mit Computern, vielleicht das Schreiben? Ich weiß nicht, ob es das einfachste ist, aber es ist definitiv einfach. In dieses einfache Textfeld können also Ausgaben geschrieben werden und jede Zeile wird eine Ausgabe sein. Sie tippen und tippen einfach und heben Ihre Hände nicht von der Tastatur, um die Maus zu greifen. Sie können auch eine in einem Texteditor oder einer Tabellenkalkulation erstellte Liste einfügen.
Es ist flexibel: Sie können das Problem jemandem (oder mehreren, Benutzernamen durch Kommas trennen) zuweisen, indem Sie den Titel mit einem senkrechten Strich vom Benutzernamen trennen. Eine weitere Pipe trennt die Beschreibung, und noch eine weitere Pipe trennt die Labels, die viele sein können, und trennt sie durch Kommas.
Update: Die App ist live unter https://fast-issues.herokuapp.com/
Technische Übersicht
Dieses Projekt ist ~noch nicht vollständig ausgearbeitet, aber bereits~ öffentlich
https://github.com/eliorivero/fast-issues _
Als allgemeine Übersicht:
- Es ist eine GitHub-App, die in dem Repository installiert werden kann, in dem die Issues erstellt werden
- hat ein Node.js-Backend mit Express als Server
- Das Frontend wird mit React erstellt
- Schlüsselbibliotheken zum schnellen Arbeiten mit GitHub in Node waren https://github.com/octokit/app.js und https://github.com/octokit/rest.js/
Eine Sache, die man im Hinterkopf behalten sollte, ist, dass wir die API-Limits nicht erreichen wollen. GitHub empfiehlt, zwischen Anfragen mindestens eine Sekunde verstreichen zu lassen. Ich habe das Skript 1,5 Sekunden zwischen jeder Anfrage zur Erstellung eines Problems angehalten, deshalb sehen Sie im GIF oben, dass die Probleme nicht sofort erstellt werden.
Weitere Ideen
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 und suchte 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 Bild müsste noch auf einem anderen Server gespeichert werden, da die Issues-API derzeit eingeschränkt ist und das Hochladen von Bildern nicht zulässt.