Khi định dạng một vấn đề GitHub cho MVVMcross, theo các thực tiễn tốt nhất có thể tăng cường sự rõ ràng, hiệu quả và sự hợp tác. Dưới đây là một số hướng dẫn chi tiết:
1. Tiêu đề mô tả **
Sử dụng tâm trạng bắt buộc và đảm bảo tiêu đề đủ mô tả để truyền đạt mục đích của vấn đề. Tránh kết thúc tiêu đề với các giai đoạn. Ví dụ: "Khắc phục lỗi trong liên kết dữ liệu" hiệu quả hơn "lỗi trong liên kết dữ liệu" hoặc "lỗi ràng buộc dữ liệu." [4] [7].2. Tổng quan rõ ràng **
Cung cấp một cái nhìn tổng quan ngắn gọn về vấn đề trong hai dòng hoặc ít hơn. Điều này nên bao gồm mục tiêu chính hoặc vấn đề đang được giải quyết. Ví dụ: "Vấn đề này nhằm mục đích giải quyết lỗi liên kết dữ liệu gây ra sự cố ứng dụng trên các thiết bị Android." [1] [4].3. Sự phụ thuộc (nếu có) **
Nếu vấn đề phụ thuộc vào một vấn đề khác đang được giải quyết trước tiên, liên kết với vấn đề đó. Điều này giúp duy trì một quy trình công việc rõ ràng và đảm bảo rằng các nhiệm vụ phụ thuộc được giải quyết theo đúng thứ tự. Ví dụ: "Vấn đề này phụ thuộc vào [liên kết đến vấn đề phụ thuộc]." [1].4. Các mục hành động **
Định dạng các mục hành động như danh sách kiểm tra có thể nhấp. Điều này giúp bạn dễ dàng theo dõi tiến trình và giao nhiệm vụ cho các thành viên trong nhóm. Ví dụ:- [] Nghiên cứu nguyên nhân của lỗi liên kết dữ liệu.
- [] thực hiện một bản sửa lỗi cho vấn đề được xác định.
- [] Kiểm tra bản sửa lỗi trên nhiều nền tảng. [1] [4].
5. Tài nguyên/hướng dẫn **
Bao gồm các liên kết đến tài liệu hoặc tài nguyên có liên quan có thể hỗ trợ giải quyết vấn đề. Điều này có thể bao gồm các hướng dẫn, tài liệu API hoặc các cuộc thảo luận trước đây liên quan đến vấn đề. Ví dụ: "Tham khảo [Tài liệu MVVMCROSS] (https://mvvmcross.com/docs) để được hướng dẫn về liên kết dữ liệu." [1] [2].6. Người được chuyển nhượng **
Gán vấn đề cho một thành viên nhóm cụ thể. Điều này đảm bảo trách nhiệm và rõ ràng về người chịu trách nhiệm cho nhiệm vụ. Sử dụng tính năng "Người được chuyển nhượng" trong GitHub để gán người dùng. [1].7. Nhãn **
Áp dụng các nhãn có liên quan để phân loại vấn đề. Điều này giúp lọc và ưu tiên các vấn đề trong dự án. Ví dụ: các nhãn có thể bao gồm "lỗi", "tính năng" hoặc "tăng cường." [1] [2].8. Ban dự án **
Đảm bảo vấn đề được thêm vào bảng dự án và được xử lý đúng cách. Điều này liên quan đến việc đặt trạng thái vấn đề thành "hộp băng" nếu nó chưa sẵn sàng ", tồn đọng ưu tiên" nếu nó sẵn sàng nhưng không được chỉ định và "đang tiến hành" sau khi được gán. [1].9. Các cột mốc **
Sử dụng các cột mốc để theo dõi tiến trình của các nhóm vấn đề hoặc yêu cầu kéo. Điều này đặc biệt hữu ích cho các dự án lớn hơn hoặc khi theo dõi nhiều nhiệm vụ liên quan. [1].10. Cập nhật tài liệu và tiến trình **
Thường xuyên cập nhật các ý kiến vấn đề với tiến trình hoặc thay đổi. Điều này giữ cho tất cả các bên liên quan được thông báo và tạo điều kiện cho việc giải quyết vấn đề hợp tác. [7].ví dụ về một vấn đề được định dạng tốt
** Tiêu đề: Khắc phục lỗi liên kết dữ liệu trên thiết bị Android
** Tổng quan: Vấn đề này giải quyết lỗi ràng buộc dữ liệu gây ra sự cố ứng dụng trên các thiết bị Android.
** Sự phụ thuộc: Phụ thuộc vào [Liên kết đến vấn đề phụ thuộc].
Mục hành động:
- [] Điều tra nguyên nhân của lỗi liên kết dữ liệu.
- [] thực hiện một bản sửa lỗi dựa trên các phát hiện.
- [] tiến hành kiểm tra kỹ lưỡng trên các nền tảng.
** Tài nguyên/Hướng dẫn: Tham khảo [Tài liệu MVVMCROSS] (https://mvvmcross.com/docs) để biết hướng dẫn ràng buộc dữ liệu.
** Người được chuyển nhượng: @Username
** Nhãn: Lỗi, Android
Bằng cách tuân theo các hướng dẫn này, bạn có thể tạo ra các vấn đề GitHub có cấu trúc tốt nhằm tăng cường sự hợp tác và hiệu quả trong dự án MVVMcross.
Trích dẫn:[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
.
[5] https://github.com/mvvmcross/mvvmcross-samples
[6] https://github.com/MVVMCROSS
.
[8] https://www.mvvmcross.com/documentation/contributing/mvvmcross-docs-style-guide
[9] https://github.com/MvvmCross/MvvmCross/blob/develop/CONTRIBUTING.md