Problemy z GitHubem są fantastyczne do śledzenia nowych funkcji lub błędów, kto jest przypisany, kategoryzowania ich, dodawania do projektów i tak dalej. Jednocześnie ich tworzenie jest dość powolne, a tworzenie ich grup zajmuje zbyt dużo czasu.
Jednym z problemów, które widzę w przypadku problemów z GitHub w pracy, jest to, że ich tworzenie jest kłopotliwe, szczególnie dla tych, którzy nie są programistami ani projektantami, takimi jak menedżerowie lub testerzy, którzy chcą zgłosić błąd bez przechodzenia przez proces ich tworzenia na GitHubie.
Jakiś czas temu pisałem o aplikacji, którą pisałem, aby przyspieszyć tworzenie spraw na GitHubie. Właściwie zbudowałem aplikację, ale zapomniałem o tym tutaj napisać, więc oto odpowiedni wpis na blogu. W tym poście zobaczymy:
- Pisanie partii problemów z GitHub za pomocą zwykłego tekstu
- Stos technologiczny za aplikacją
- Więcej pomysłów na usprawnienie tworzenia problemów
Dlaczego aplikacja do szybszego tworzenia problemów na GitHubie?
Interfejs użytkownika GitHub jest zwykle w porządku, aby utworzyć problem. Lub dwa. I jest w porządku dla osób obeznanych z technologią, takich jak programiści lub projektanci. Jednak w naszej firmie Reconnect, czasami po opracowaniu nowej funkcji, prosimy naszych pracowników nietechnicznych o jej przetestowanie. I to działa świetnie, ponieważ zwykle znajdują jakieś problemy. Ale przeglądanie interfejsu problemów z GitHub jest dla nich bardzo czasochłonne. Jest to jeszcze bardziej kłopotliwe, gdy muszą tworzyć więcej niż jedno wydanie i prawdopodobnie w różnych repozytoriach.
Jeśli określimy, ile razy kierujemy naszą uwagę na tworzenie zgłoszeń na GitHubie po dotarciu do strony tworzenia zgłoszenia w repozytorium, w którym chcemy je utworzyć, byłoby to mniej więcej takie:
- wpisz tytuł
- przejdź do pola tekstowego problemu, aby wprowadzić opis
- przejdź do paska bocznego, aby przypisać komuś problem
- przejdź do bloku Etykiety na pasku bocznym, aby dodać etykietę
- idź i kliknij przycisk, aby faktycznie utworzyć problem
To 5 razy, kiedy przenosimy naszą uwagę z obszaru na obszar! Zbyt dużo uwagi poświęca się zadaniu, które zasadniczo polega na pisaniu i zbyt wiele czasu spędzanego na ponownym skupieniu się. A co, jeśli musisz napisać sprawę w innym repozytorium? Musisz przejść do tego repozytorium w nowej karcie lub w bieżącej, a to więcej straconego czasu.
Jak więc łatwiej i szybciej tworzyć problemy na GitHubie? Czy nie byłoby łatwiej, gdybyśmy mogli to zrobić skoncentrowani na jednym miejscu bez konieczności wielokrotnego przenoszenia uwagi?
Pisanie partii problemów z GitHub za pomocą zwykłego tekstu
Pisanie to jedna z najbardziej podstawowych umiejętności na urządzeniach, jest bardziej podstawowa niż choćby gesty dotykowe. Ponieważ chociaż są one specyficzne dla urządzeń dotykowych, musisz użyć myszy lub gładzika na innych. Ale pisanie jest zwykle zawsze takie samo. A problemy z GitHub to tekst, więc dlaczego nie używać tekstu do ich tworzenia bez opuszczania naszej klawiatury?
Ta aplikacja robi dokładnie to: https://fast-issues.herokuapp.com/
Autoryzujesz tę aplikację GitHub i możesz zacząć pisać problemy we wszystkich swoich repozytoriach. Musisz tylko wybrać repozytorium, w którym chcesz utworzyć sprawę i zacząć pisać wiele spraw, po jednej w każdym wierszu.
I obsługuje pisanie tytułu i opisu, przypisywanie go i etykietowanie. Wymaga tylko tytułu wydania. Reszta jest opcjonalna. Musisz tylko przestrzegać określonej konwencji:
- tytuł jest na pierwszym miejscu
- następnie znak kreski oddziela osoby przypisane. Wybrałem tak, ponieważ potrzebujesz minimum problemu i kogoś, kto nad nim popracuje
- druga kreska kreski oddziela opis problemu. Może mieć dowolną długość, ale nie może mieć żadnych łamania linii, ponieważ rozpoczynałoby to nowy numer
- trzeci znak kreski oddziela etykiety
Obsługuje wielu cesjonariuszy i etykiety, oddzielając je przecinkiem. Więc w zasadzie:
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
Po zakończeniu wystarczy kliknąć przycisk Go! przycisk i stworzy wszystkie problemy. Każdy będzie miał Ciebie jako autora. Możesz później je edytować, aby dodać obrazy lub filmy, memy, cokolwiek.
Jeśli chcesz utworzyć więcej zgłoszeń w innym repozytorium, po prostu wybierz je ponownie z listy rozwijanej i zacznij pisać te zgłoszenia. Nigdy więcej przeskakiwania przez strony!
Stos technologiczny za aplikacją
Repozytorium tej aplikacji znajduje się pod adresem https://github.com/eliorivero/fast-issues
Stos technologiczny jest szczególnie prosty i całkowicie oparty na JavaScript :
- frontend zbudowany za pomocą React
- backend zbudowany z Node.js
- używa Express jako serwera
- i Octokit REST biblioteka do pracy z GitHub API
Należy pamiętać, że nie chcemy przekraczać limitu żądań dozwolonego przez interfejs API GitHub Issues. Zalecają, aby między żądaniami minęła co najmniej jedna sekunda, więc wstrzymałem wykonanie 1,5 sekundy między utworzeniem każdego problemu.
Od początkowego prototypu, który wykonałem, do ostatecznej wersji, zmieniłem go z aplikacji GitHub na aplikację OAuth. To dlatego, że ta ostatnia pozwala tworzyć problemy i występować jako autor.
Więcej pomysłów na usprawnienie tworzenia problemów
Pokazałem to znajomemu, a on powiedział mi, że wpadł na pomysł stworzenia rozszerzenia Chrome, aby zrobić zrzut ekranu błędu, opisać go i przesłać jako problem z GitHub. Pomyślałem, że to świetny pomysł, więc szukałem sposobu na zrobienie zrzutu ekranu, ale w aplikacji React szybko znalazłem html2canvas, który pozwala robić zrzuty ekranu i zapisywać je jako pliki PNG.
Połączenie czegoś takiego z moim narzędziem do tworzenia problemów byłoby fajnym rozwiązaniem, które mogłoby być dostępne w aplikacji React podczas jej cyklu rozwoju lub postoju. Każdy, kto testuje aplikację, może uruchomić panel zgłaszania problemów i zgłosić problem na GitHubie.
Jedynym problemem z tym na razie jest to, że API GitHub nie pozwala na przesyłanie obrazów, więc musiałyby być hostowane gdzie indziej i mieć link do tej lokalizacji wstawiony w tym narzędziu, ale to zdecydowanie dobre ulepszenie.
Więc znowu, aplikacja jest na https://fast-issues.herokuapp.com/ i jeśli w końcu jej użyjesz, daj mi znać w komentarzach.