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

Báo cáo vấn đề Xem nguồn

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

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 các kỹ sư và người viết về kỹ thuật viết ra. Hầu hết trang web này là tài liệu tường thuật trình bày hướng dẫn về khái niệm và nhiệm vụ.
  • 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 thay đổi các trang tài liệu tham khảo, mà cần thay đổi nguồn của chúng.

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

Tài liệu về Bazel được phân phát từ Google và các tệp nguồn được đồng bộ hoá hai 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 đơn vị bảo 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ể áp dụng các thay đổi nhỏ, chẳng hạn như sửa lỗi hoặc lỗi chính tả, theo một số cách.

  • Yêu cầu lấy dữ liệu. Bạn có thể tạo một yêu cầu kéo trong GitHub bằng trình chỉnh sửa dựa trên nền tảng 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, sau đó chủ sở hữu tài liệu Bazel sẽ cập nhật.

Thay đổi lớn

Nếu muốn thay đổi đáng kể tài liệu hiện có hoặc đề xuất tài liệu mới, bạn có thể tạo một yêu cầu kéo (pull request) hoặc bắt đầu bằng một tài liệu Google rồi liên hệ với Bazel Owners (Chủ sở hữu Bazel) để cộng tác.