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

Báo cáo vấn đề Xem nguồn Nightly · 8.4 · 8.3 · 8.2 · 8.1 · 8.0 · 7.6

Cảm ơn bạn đã đóng góp cho tài liệu của Bazel! Có một số cách để giúp tạo ra tài liệu chất lượng 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 các chuyên viên soạn tài liệu kỹ thuật và kỹ sư viết. Phần lớn nội dung trên trang web này là tài liệu tường thuật, bao gồm các hướng dẫn dựa trên khái niệm và tác vụ.
  • Tài liệu tham khảo là tài liệu được tạo từ các nhận xét trong mã. Bạn không thể thay đổi trực tiếp các trang tài liệu tham khảo mà cần phải thay đổi nguồn của các trang đó.

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

Tài liệu về Bazel được cung cấp 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ể thay đổ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à người duy trì Bazel sẽ cập nhật nguồn trang web để xuất bản nội dung cập nhật của bạn.

Thay đổi nhỏ

Bạn có thể thực hiện những 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 kéo. Bạn có thể tạo yêu cầu kéo trong GitHub bằng 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 đề 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 thực hiện những thay đổi đáng kể đối với 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 hoặc bắt đầu bằng một tài liệu trên Google rồi liên hệ với Chủ sở hữu Bazel để cộng tác.