Cảm ơn bạn đã đóng góp cho tài liệu của Bazel! Sau đây là một số cách giúp tạo 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 dạng tường thuật do các kỹ sư và nhà văn kỹ thuật viết. Phần lớn trang web này là tài liệu dạng văn bản bao gồm các hướng dẫn dựa trên khái niệm và nhiệm vụ.
- Tài liệu tham khảo, là tài liệu được tạo từ các nhận xét 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 các trang đó.
Cơ sở hạ tầng 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 phản ánh 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à một trình duy trì Bazel sẽ cập nhật nguồn trang web để phát hành nội dung cập nhật của bạn.
Thay đổi nhỏ
Bạn có thể thực hiện một số 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ể gửi lỗi kèm theo thông tin chi tiết và nội dung thay đổi đề xuất. Chủ sở hữu tài liệu Bazel sẽ cập nhật nội dung đó.
Thay đổi lớn
Nếu muốn thực hiện các 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 yêu cầu kéo hoặc bắt đầu bằng tài liệu Google và liên hệ với Chủ sở hữu Bazel để cộng tác.