Podczas formatowania problemu GitHub dla MVVMCROSS, przestrzeganie najlepszych praktyk może zwiększyć jasność, wydajność i współpracę. Oto kilka szczegółowych wytycznych:
1. Tytuły opisowe **
Użyj imperatywnego nastroju i upewnij się, że tytuł jest wystarczająco opisowy, aby przekazać cel problemu. Unikaj zakończenia tytułów z okresami. Na przykład „naprawienie błędu w wiązaniu danych” jest bardziej skuteczne niż „błąd w wiązaniu danych” lub „Błąd wiązania danych.” [4] [7].2. Wyczyść przegląd **
Zapewnij zwięzły przegląd problemu w dwóch lub mniej liniach. Powinno to obejmować główny cel lub rozwiązany problem. Na przykład „Ten problem ma na celu rozwiązanie błędu wiązania danych powodujących awarie aplikacji na urządzeniach z Androidem.” [1] [4].3. Zależność (jeśli dotyczy) **
Jeśli problem zależy od pierwszego problemu, link do tego problemu. Pomaga to utrzymać wyraźny przepływ pracy i zapewnia, że zadania zależne są adresowane we właściwej kolejności. Na przykład „Ten problem zależy od [link do problemu zależnego].” [1].4. Przedmioty akcji **
FORMAT INTEKTY AKCJI JAKO KLIKACJE LISTY KONTROLNE. Ułatwia to śledzenie postępów i przypisywanie zadań członkom zespołu. Na przykład:- [] Zbadaj przyczynę błędu wiązania danych.
- [] wdrożyć poprawkę do zidentyfikowanego wydania.
- [] Testuj poprawkę na wielu platformach. [1] [4].
5. Zasoby/instrukcje **
Dołącz linki do odpowiedniej dokumentacji lub zasobów, które mogą pomóc w rozwiązaniu problemu. Może to obejmować samouczki, dokumentację API lub wcześniejsze dyskusje związane z problemem. Na przykład „Patrz [Dokumentacja MVVMCROSS] (https://mvvmcross.com/docs), aby uzyskać wskazówki dotyczące wiązania danych.” [1] [2].6. Cessione **
Przypisz ten problem do konkretnego członka zespołu. Zapewnia to odpowiedzialność i jasność tego, kto jest odpowiedzialny za zadanie. Użyj funkcji „cesjonariusze” w GitHub, aby przypisać użytkownikom. [1].7. Etykiety **
Zastosuj odpowiednie etykiety, aby kategoryzować problem. Pomaga to w filtrowaniu i priorytetach problemów w ramach projektu. Na przykład etykiety mogą zawierać „błąd”, „funkcja” lub „ulepszenie.” [1] [2].8. Project Board **
Upewnij się, że problem zostanie dodany do tablicy projektowej i odpowiednio rozt. Obejmuje to ustawienie statusu problemu na „Ice Box”, jeśli nie jest gotowy, „priorytetowe zaległości”, jeśli jest gotowy, ale nie przypisany, i „w toku” po przypisaniu. [1].9. Kamienie milowe **
Użyj kamieni milowych, aby śledzić postęp grup problemów lub pobierać żądania. Jest to szczególnie przydatne w przypadku większych projektów lub podczas śledzenia wielu powiązanych zadań. [1].10. Dokumentacja i aktualizacje postępów **
Regularnie aktualizuj komentarze wydania o postępy lub zmiany. To informuje wszystkie zainteresowane strony i ułatwia wspólne rozwiązywanie problemów. [7].Przykład dobrze formatowanego problemu
** Tytuł: Napraw błąd wiązania danych na urządzeniach z Androidem
** Omówienie: Ten problem dotyczy błędu wiązania danych powodujących awarie aplikacji na urządzeniach z Androidem.
** Zależność: zależy od [link do problemu zależnego].
Elementy akcji:
- [] Zbadaj przyczynę błędu wiązania danych.
- [] wdrożyć poprawkę na podstawie ustaleń.
- [] Przeprowadź dokładne testy na platformach.
** Zasoby/instrukcje: Aby uzyskać wytyczne dotyczące wiązania danych, patrz [Dokumentacja MVVMCROSS] (https://mvvmcross.com/docs).
** Cessiones: @username
** Etykiety: Bug, Android
Postępując zgodnie z tymi wytycznymi, możesz stworzyć dobrze ustrukturyzowane problemy GitHub, które zwiększają współpracę i wydajność w ramach projektu MVVMCROSS.
Cytaty:[1] https://www.hackforla.org/guide-pages/github-issues.html
[2] https://github.com/mvvmcross/mvvmcross
[3] https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/organizing-information-with-tables
[4] https://tilburgsciencehub.com/topics/automation/version-control/start-git/write-good-issues/
[5] https://github.com/mvvmcross/mvvmcross-samples
[6] https://github.com/mvvmcross/mvvmcross-samples/blob/master/readme.md
[7] https://gitprotect.io/blog/mastering-github-issues-best-practices-and-pro-tips/
[8] https://www.mvvmcross.com/documentation/contributing/mvvmcross-docs-style-guide
[9] https://github.com/mvvmcross/mvvmcross/blob/develop/contributing.md