Yêu cầu kéo giống như máu sống của kho lưu trữ. Chúng giữ cho mọi thứ đều khoẻ và vận động. Trang này trình bày chi tiết cách tạo một PR hoàn chỉnh và dễ xem lại, giúp tăng khả năng PR của bạn sẽ được hợp nhất.
Dưới đây là các bước bạn có thể thực hiện để đảm bảo tạo được bài PR tốt nhất có thể.
- Thông tin liên lạc
- Bắt đầu thiết lập
- Kích thước nhỏ
- Giữ vệ sinh sạch sẽ
- Kiểm tra thay đổi
- Giao tiếp (pt2)
Giao tiếp
Trước khi bắt đầu viết mã, bạn nên trao đổi với nhóm nòng cốt để họ biết bạn quan tâm đến điều gì.
Nếu có sự cố bạn quan tâm, hãy nhận xét về sự cố đó cho biết bạn sẽ bắt đầu xử lý. Điều này giúp đảm bảo rằng không có nhiều người cùng làm việc trong một lĩnh vực. Một thành viên trong nhóm sẽ trả lời để xác nhận rằng số điện thoại đó là của bạn.
Nếu bạn có ý tưởng không thuộc vấn đề nào, vui lòng viết một ý tưởng trước khi bắt đầu làm việc. Điều này giúp nhóm có cơ hội thảo luận về cách tốt nhất để xây dựng thay đổi trước khi bắt đầu xây dựng, giúp bạn tiết kiệm công sức về lâu dài.
Bắt đầu thiết lập
Nếu đây là lần đầu tiên bạn đóng góp cho tính năng Mẫu theo khối hoặc mẫu chặn, hãy bắt đầu trên trang thiết lập phát triển.
Nhỏ gọn
Hãy luôn cố gắng thực hiện những thay đổi nhỏ và có trọng tâm. Chúng tôi muốn xem xét nhiều PR nhỏ hơn là xem xét một PR lớn. Một số nguyên tắc chung là:
- Khắc phục một vấn đề. Đừng cố giải quyết nhiều vấn đề cùng một lúc.
- Giới hạn phạm vi. Thông thường một PR sẽ mất chưa đến 8 giờ (tuỳ thuộc vào mức độ quen thuộc của bạn với cơ sở mã).
- Sử dụng thay đổi. Nếu PR của bạn hơi lớn, hãy chia các thay đổi thành các nhóm logic bằng cách sử dụng git báo cáo.
Giữ vệ sinh sạch sẽ
Tại sao nên quan tâm đến kiểu mã? Chúng tôi hướng đến mục tiêu lâu dài và phong cách nhất quán giúp việc bảo trì dễ dàng hơn. Kiểu là cách bạn đặt tên cho các biến, cũng như cách bạn cấu trúc mã, viết nhận xét và nhiều hoạt động khác. Khi có thể, chúng tôi sử dụng các công cụ như eslint để tự động hoá việc kiểm tra kiểu.
Ngoài eslint, vui lòng làm theo các hướng dẫn sau:
- Hướng dẫn quy tắc lập trình JavaScript của Google.
- Hướng dẫn về tin nhắn xác nhận
- Nguyên tắc sử dụng API Blockly
- Hướng dẫn quy tắc của Lớp học lập trình
Kiểm tra thay đổi của bạn
Trước khi tạo một PR, bạn nên luôn kiểm thử để đảm bảo rằng các thay đổi của bạn đang hoạt động hiệu quả để không phải quay lại và khắc phục vấn đề sau này. Dưới đây là một số ý tưởng để kiểm thử nhiều danh mục dự án:
- Đối với trình bổ trợ: viết chương trình kiểm thử mocha tự động để áp dụng cho các thay đổi của bạn.
- Ví dụ: ví dụ: thử nghiệm tất cả chức năng được minh hoạ theo cách thủ công.
- Đối với codelabs: chạy qua toàn bộ hướng dẫn trong một môi trường sạch và kiểm thử bất kỳ mã mẫu nào mà bạn cung cấp.
Giao tiếp
Đây là phần cuối cùng và có thể cho là quan trọng nhất trong quá trình tạo một PR: viết phần tóm tắt.
Việc viết một bản tóm tắt PR phù hợp sẽ giúp các nhà phát triển khác xem xét thay đổi của bạn, tăng khả năng bản tóm tắt được chấp nhận nhanh hơn!
Bản tóm tắt của bạn nên bao gồm những nội dung như:
- Vấn đề liên quan đến PR của bạn.
- Thay đổi bổ sung cho lời PR của bạn.
- Cách bạn thử nghiệm thay đổi của mình.
- Mọi thứ bạn muốn người đánh giá xem xét kỹ lưỡng.
- Mọi thông tin khác mà bạn cho rằng người đánh giá cần.
Nếu bạn làm theo mẫu PR khi tạo yêu cầu thì bạn đã sẵn sàng. Chỉ cần nhớ ngắn gọn và đầy đủ nhất có thể.
Chúc bạn lập trình vui vẻ!