Viết một yêu cầu lấy dữ liệu hợp lý

Yêu cầu kéo giống như nguồn sống của kho lưu trữ. Các thành phần này giúp mọi thứ hoạt động trơn tru và hiệu quả. Trang này trình bày chi tiết cách tạo một yêu cầu thay đổi hoàn chỉnh và dễ xem xét, giúp tăng khả năng yêu cầu thay đổi của bạn đượ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 ra nội dung PR hiệu quả nhất có thể.

  1. Thông tin liên lạc
  2. Thiết lập
  3. Giữ kích thước nhỏ
  4. Gọn gàng
  5. Kiểm thử nội dung thay đổi
  6. Giao tiếp (phần 2)

Liên lạc

Trước khi bắt tay vào viết mã, bạn nên trao đổi với nhóm cốt lõi để họ biết bạn quan tâm đến điều gì.

Nếu có vấn đề mà bạn quan tâm, hãy để lại nhận xét về vấn đề đó và cho biết bạn sẽ bắt đầu xử lý vấn đề đó. Điều này giúp đảm bảo rằng chúng ta không có nhiều người làm việc cùng một việc. Một thành viên trong nhóm sẽ trả lời để xác nhận rằng đó là tài khoản của bạn.

Nếu bạn có ý tưởng không được đề cập trong một vấn đề, vui lòng viế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 để triển khai thay đổi trước khi bạn 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 Blockly hoặc blockly-samples, hãy bắt đầu từ trang thiết lập phát triển.

Giữ kích thước nhỏ

Luôn cố gắng giữ cho các thay đổi của bạn nhỏ và tập trung. Chúng tôi thà xem xét nhiều yêu cầu hỗ trợ nhỏ hơn là xem xét một yêu cầu hỗ trợ lớn. Sau đây là một số quy tắc hay:

  • Khắc phục một vấn đề. Đừng cố gắng 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 yêu cầu thay đổi sẽ mất ít hơ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 các thay đổi. Nếu bạn cảm thấy yêu cầu thay đổi của mình hơi lớn, hãy chia các thay đổi thành các nhóm hợp lý bằng cách sử dụng các thay đổi git.

Thiết kế gọn gàng

Tại sao bạn nên quan tâm đến kiểu mã? Chúng tôi sẽ làm việc lâu dài và phong cách nhất quán giúp việc bảo trì trở nên dễ dàng hơn. Kiểu đề cập đến cách bạn đặt tên cho biến, nhưng cũng bao gồm cách bạn định cấu trúc mã, viết nhận xét và nhiều nội dung khác. Nếu có thể, chúng ta sẽ 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:

Kiểm thử thay đổi

Trước khi đăng một yêu cầu thay đổi, bạn phải luôn kiểm tra để đảm bảo rằng các thay đổi của mình đang hoạt động, nhờ đó bạn không phải quay lại sửa lỗi sau này. Dưới đây là một số ý tưởng để kiểm thử các danh mục dự án khác nhau:

  • Đối với trình bổ trợ: hãy viết các chương trình kiểm thử mocha tự động bao gồm các thay đổi của bạn.
  • Ví dụ: kiểm thử theo cách thủ công tất cả chức năng đã minh hoạ.
  • Đối với codelabs: hãy chạy toàn bộ hướng dẫn trong một môi trường sạch và kiểm thử mọi mã mẫu mà bạn cung cấp.

Liên lạc

Đây là phần cuối cùng và có thể là quan trọng nhất trong quá trình tạo thông cáo báo chí: viết nội dung tóm tắt.

Việc viết một bản tóm tắt tuyệt vời về hoạt động quan hệ công chúng sẽ giúp các nhà phát triển khác xem xét các thay đổi của bạn, nhờ đó, các thay đổi đó có nhiều khả năng được chấp nhận nhanh hơn!

Bản tóm tắt của bạn phải bao gồm những thông tin như:

  • Vấn đề liên quan đến thông cáo báo chí của bạn.
  • Nội dung thay đổi mà thông cáo báo chí của bạn thêm vào.
  • Cách bạn kiểm thử nội dung thay đổi.
  • Mọi nội dung mà 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 biết.

Nếu làm theo mẫu PR khi tạo yêu cầu, bạn sẽ không gặp vấn đề gì. Chỉ cần nhớ giới thiệu ngắn gọn và hoàn chỉnh nhất có thể.

Chúc bạn lập trình vui vẻ!