Đóng góp cho tài liệu về Bazel

Báo cáo vấn đề Xem nguồn Hằng đêm · 7.3 · 7.2 · 7.1 · 7 · 6,5

Cảm ơn bạn đã đóng góp tài liệu của Bazel! Có một vài cách để giúp tạo ra các tài liệu tốt hơn cho cộng đồng của chúng ta.

Các loại tài liệu

Trang web này có một số loại nội dung.

  • Tài liệu tường thuật do người viết về kỹ thuật và kỹ sư. Hầu hết nội dung trên trang web này là tài liệu tường thuật bao gồm hướng dẫn dựa trên nhiệm vụ và khái niệm.
  • Tài liệu tham khảo, được tạo từ các nhận xét trong mã. Bạn không thể trực tiếp thực hiện các thay đổi trên các trang tài liệu tham khảo, mà thay vào đó cần phải thay đổi nguồn.

Cơ sở hạ tầng của tài liệu

Tài liệu trong Bazel được phân phối từ Google và các tệp nguồn được phản chiếu trong Kho lưu trữ GitHub của Bazel. Bạn có thể thực hiện thay đổi đối với các tệp nguồn trong GitHub. Nếu được phê duyệt, bạn có thể hợp nhất các thay đổi đó và một người duy trì Bazel sẽ cập nhật nguồn trang web để xuất bản các bản cập nhật của bạn.

Thay đổi nhỏ

Bạn có thể tiến hành những thay đổi nhỏ, chẳng hạn như sửa lỗi hoặc lỗi chính tả, bằng một vài cách nhiều cách.

  • Yêu cầu lấy dữ liệu. Bạn có thể tạo một yêu cầu lấy dữ liệu (pull request) trong GitHub bằng phương thức trình chỉnh sửa dựa trên web hoặc trên một nhánh.
  • Lỗi. Bạn có thể báo cáo lỗi kèm theo thông tin chi tiết và các thay đổi được đề xuất cũng như Bazel chủ sở hữu tài liệu sẽ thực hiện cập nhật.

Thay đổi lớn

Nếu bạn muốn thay đổi đáng kể tài liệu hoặc đề xuất hiện tại, tài liệu mới, bạn có thể tạo một yêu cầu lấy dữ liệu hoặc bắt đầu bằng một tài liệu và liên hệ với Bazel Owners để cộng tác.