Google is committed to advancing racial equity for Black communities. See how.
Trang này được dịch bởi Cloud Translation API.
Switch to English

Quy trình TensorFlow RFC

Mọi tính năng TensorFlow mới bắt đầu hoạt động dưới dạng Yêu cầu bình luận (RFC).

RFC là một tài liệu mô tả một yêu cầu và những thay đổi được đề xuất sẽ giải quyết nó. Cụ thể, RFC sẽ:

  • Được định dạng theo mẫu RFC .
  • Được gửi dưới dạng một yêu cầu kéo đến thư mục cộng đồng / rfcs .
  • Được thảo luận và họp đánh giá trước khi chấp nhận.

Mục đích của Yêu cầu Nhận xét TensorFlow (RFC) là thu hút sự phát triển của cộng đồng TensorFlow, bằng cách nhận phản hồi từ các bên liên quan và các chuyên gia, đồng thời truyền đạt những thay đổi thiết kế một cách rộng rãi.

Cách gửi RFC

  1. Trước khi gửi RFC, hãy thảo luận về mục tiêu của bạn với những người đóng góp và bảo trì dự án và nhận phản hồi sớm. Sử dụng danh sách gửi thư của nhà phát triển cho dự án liên quan (Develop@tensorflow.org hoặc danh sách cho SIG có liên quan).

  2. Dự thảo RFC của bạn.

    • Làm theo mẫu RFC .
    • Đặt tên tệp RFC của bạn là YYYYMMDD-descriptive-name.md , trong đó YYYYMMDD là ngày gửi và descriptive-name liên quan đến tiêu đề RFC của bạn. (Ví dụ: nếu RFC của bạn có tiêu đề API tiện ích song song , bạn có thể sử dụng tên tệp 20180531-parallel-widgets.md .
    • Nếu bạn có hình ảnh hoặc các tệp bổ trợ khác, hãy tạo một thư mục có dạng YYYYMMDD-descriptive-name để lưu các tệp đó.

    Sau khi viết bản nháp RFC, hãy nhận phản hồi từ những người bảo trì và những người đóng góp trước khi gửi nó.

    Viết mã triển khai không phải là một yêu cầu, nhưng nó có thể giúp ích cho các cuộc thảo luận về thiết kế.

  3. Tuyển dụng một nhà tài trợ.

    • Nhà tài trợ phải là người duy trì dự án.
    • Xác định nhà tài trợ trong RFC, trước khi đăng bài PR.

    Bạn có thể đăng RFC mà không có nhà tài trợ, nhưng nếu trong vòng một tháng kể từ khi đăng bài PR mà vẫn không có nhà tài trợ, nó sẽ bị đóng.

  4. Gửi RFC của bạn dưới dạng một yêu cầu kéo tới tensorflow / community / rfcs .

    Bao gồm bảng tiêu đề và nội dung của phần Mục tiêu trong nhận xét của yêu cầu kéo của bạn, sử dụng Markdown. Để có ví dụ, vui lòng xem RFC ví dụ này . Bao gồm tay cầm GitHub của đồng tác giả, người đánh giá và nhà tài trợ.

    Ở đầu bài PR, hãy xác định khoảng thời gian bình luận sẽ là bao lâu. Thời gian tối thiểu là hai tuần kể từ khi đăng bài PR.

  5. Gửi email cho danh sách gửi thư của nhà phát triển kèm theo mô tả ngắn gọn, liên kết đến PR và yêu cầu đánh giá. Thực hiện theo định dạng của các thư trước, như bạn có thể thấy trong ví dụ này .

  6. Nhà tài trợ sẽ yêu cầu một cuộc họp của ủy ban đánh giá, không sớm hơn hai tuần sau khi RFC PR được đăng. Nếu thảo luận sôi nổi, hãy đợi cho đến khi nó lắng xuống trước khi xem xét. Mục tiêu của cuộc họp xem xét là giải quyết các vấn đề nhỏ; Cần đạt được sự đồng thuận về các vấn đề lớn trước đó.

  7. Cuộc họp có thể thông qua RFC, từ chối nó hoặc yêu cầu thay đổi trước khi nó có thể được xem xét lại. Các RFC được phê duyệt sẽ được hợp nhất vào cộng đồng / rfcs và các RFC bị từ chối sẽ bị đóng PR của họ.

Người tham gia RFC

Nhiều người tham gia vào quá trình RFC:

  • Tác giả RFC - một hoặc nhiều thành viên cộng đồng viết RFC và cam kết vô địch nó trong suốt quá trình

  • Nhà tài trợ RFC - người bảo trì tài trợ RFC và sẽ quản lý nó thông qua quá trình xem xét RFC

  • ủy ban đánh giá - một nhóm các nhà bảo trì có trách nhiệm đề xuất việc áp dụng RFC

  • Bất kỳ thành viên nào trong cộng đồng đều có thể giúp đỡ bằng cách cung cấp phản hồi về việc liệu RFC có đáp ứng nhu cầu của họ hay không.

Nhà tài trợ RFC

Nhà tài trợ là người duy trì dự án chịu trách nhiệm đảm bảo kết quả tốt nhất có thể của quá trình RFC. Điêu nay bao gôm:

  • Vận động cho thiết kế được đề xuất.
  • Hướng dẫn RFC tuân thủ các quy ước về kiểu dáng và thiết kế hiện có.
  • Hướng dẫn hội đồng xét duyệt đi đến thống nhất hiệu quả.
  • Nếu ủy ban đánh giá yêu cầu những thay đổi, hãy đảm bảo những thay đổi này được thực hiện và tìm kiếm sự chấp thuận sau đó của các thành viên ủy ban.
  • Nếu RFC chuyển sang triển khai:
    • Đảm bảo việc triển khai đề xuất tuân theo thiết kế.
    • Phối hợp với các bên thích hợp để thực hiện đất đai thành công.

Ủy ban đánh giá RFC

Ủy ban xem xét quyết định trên cơ sở đồng thuận về việc chấp thuận, từ chối hoặc yêu cầu thay đổi. Họ chịu trách nhiệm về:

  • Đảm bảo rằng các mục quan trọng của phản hồi công khai đã được tính đến.
  • Thêm ghi chú cuộc họp của họ làm bình luận cho PR.
  • Cung cấp lý do cho quyết định của họ.

Thành phần của ủy ban đánh giá có thể thay đổi tùy theo phong cách quản trị và sự lãnh đạo cụ thể của từng dự án. Đối với TensorFlow cốt lõi, ủy ban sẽ bao gồm những người đóng góp cho dự án TensorFlow, những người có chuyên môn trong lĩnh vực miền liên quan.

Các thành viên cộng đồng và quy trình RFC

Mục đích của RFC là đảm bảo cộng đồng được đại diện và phục vụ tốt bởi những thay đổi mới đối với TensorFlow. Các thành viên trong cộng đồng có trách nhiệm tham gia xem xét các RFC nếu họ quan tâm đến kết quả.

Các thành viên cộng đồng quan tâm đến RFC nên:

  • Cung cấp phản hồi càng sớm càng tốt để có đủ thời gian xem xét.
  • Đọc kỹ RFC trước khi cung cấp phản hồi.
  • Hãy dân sự và xây dựng .

Triển khai các tính năng mới

Khi RFC đã được phê duyệt, việc triển khai có thể bắt đầu.

Nếu bạn đang làm việc trên mã mới để triển khai RFC:

  • Đảm bảo rằng bạn hiểu tính năng và thiết kế đã được phê duyệt trong RFC. Đặt câu hỏi và thảo luận về cách tiếp cận trước khi bắt đầu công việc.
  • Các tính năng mới phải bao gồm các bài kiểm tra đơn vị mới để xác minh tính năng hoạt động như mong đợi. Bạn nên viết các bài kiểm tra này trước khi viết mã.
  • Làm theo Hướng dẫn kiểu mã TensorFlow
  • Thêm hoặc cập nhật tài liệu API có liên quan. Tham khảo RFC trong tài liệu mới.
  • Thực hiện theo bất kỳ nguyên tắc nào khác được trình bày trong tệp CONTRIBUTING.md trong repo dự án mà bạn đang đóng góp.
  • Chạy thử nghiệm đơn vị trước khi gửi mã của bạn.
  • Làm việc với nhà tài trợ RFC để hạ cánh thành công mã mới.

Giữ thanh cao

Mặc dù chúng tôi khuyến khích và tán dương mọi người đóng góp, nhưng ngưỡng chấp nhận RFC vẫn được duy trì ở mức cao. Một tính năng mới có thể bị từ chối hoặc cần sửa đổi đáng kể ở bất kỳ giai đoạn nào sau đây:

  • Các cuộc trò chuyện thiết kế ban đầu trên danh sách gửi thư có liên quan.
  • Không tuyển được nhà tài trợ.
  • Phản đối quan trọng trong giai đoạn phản hồi.
  • Không đạt được sự đồng thuận trong quá trình xem xét thiết kế.
  • Mối quan tâm được đưa ra trong quá trình thực hiện (ví dụ: không có khả năng đạt được khả năng tương thích ngược, lo ngại về bảo trì).

Nếu quá trình này hoạt động tốt, các RFC có thể sẽ thất bại trong các giai đoạn sớm hơn là muộn hơn. RFC được phê duyệt không đảm bảo cam kết thực hiện và việc chấp nhận triển khai RFC được đề xuất vẫn phải tuân theo quy trình xem xét mã thông thường.

Nếu bạn có bất kỳ câu hỏi nào về quy trình này, vui lòng hỏi trong danh sách gửi thư của nhà phát triển hoặc gửi vấn đề trong tensorflow / cộng đồng .