Hướng dẫn dự án

Ảnh xem trước khi chia sẻ GitHub: kích thước, cài đặt và danh sách kiểm tra

Ảnh xem trước của kho mã là hình ảnh mọi người có thể thấy khi liên kết được chia sẻ. Dùng tên ngắn, một giá trị hữu ích và ví dụ dễ nhận biết để giải thích dự án trong nháy mắt. Nó bổ sung chứ không thay thế README.

Ban biên tập GitHubStart · Cập nhật

Chuẩn bị đúng tệp

Hướng dẫn hiện tại của GitHub chấp nhận tệp PNG, JPG hoặc GIF dưới 1 MB. Kích thước khuyến nghị tối thiểu là 640 × 320 pixel, và 1280 × 640 cho hiển thị tốt nhất. Bắt đầu với khung 2:1 lớn hơn, rồi kiểm tra khả năng đọc ở kích thước nhỏ hơn nhiều.

Với công cụ kiểm tra CSV giả định, bố cục rõ ràng có thể gồm tên dự án, “Kiểm tra tệp CSV trước khi nhập” và ví dụ đơn giản từ dữ liệu đầu vào đến lỗi. Đừng nhét cả phiên làm việc terminal vào ảnh thu nhỏ. Đặt chữ quan trọng xa mép để phòng trường hợp nơi chia sẻ cắt ảnh.

Tải lên và kiểm tra liên kết được chia sẻ

Mở Settings của kho mã, tìm Social preview, chọn Edit rồi tải ảnh lên. Chia sẻ URL kho mã công khai tại nơi khán giả sẽ nhìn thấy và kiểm tra kết quả ở đó. Tải lên thành công không bảo đảm mọi nền tảng lập tức thay bản xem trước trong bộ nhớ đệm.

  • Xác nhận ảnh thuộc về kho mã bạn đang chia sẻ.
  • Kiểm tra định dạng, kích thước pixel và dung lượng tệp trước khi tải lên.
  • Dùng độ tương phản dễ đọc; kiểm tra ảnh trong suốt trên cả nền sáng và tối.
  • Nếu ảnh vẫn cũ, xác nhận cài đặt kho mã đã lưu và tìm hiểu bộ nhớ đệm của nền tảng đích.

Giữ bản xem trước nhất quán với dự án

Dùng cùng tên và mục đích dự án trong ảnh, README và thông báo phát hành. Nếu ảnh chụp hiển thị tính năng thử nghiệm, hãy ghi rõ hoặc dùng quy trình ổn định. Không thêm số Star bịa đặt, logo khách hàng hay tuyên bố hiệu năng không có thật.

Xem lại ảnh khi trường hợp sử dụng cốt lõi thay đổi. Bản xem trước là tài sản truyền thông, không phải bảo đảm riêng về thứ hạng, tỷ lệ nhấp hay GitHub Star.

Câu hỏi thường gặp

Đây có phải ảnh đại diện của chủ kho mã không?

Không. Ảnh đại diện nhận diện tài khoản. Ảnh xem trước tùy chỉnh của kho mã đại diện cho một dự án cụ thể khi chia sẻ liên kết.

Ảnh xem trước có dùng nền trong suốt được không?

GitHub hỗ trợ độ trong suốt của PNG. Kiểm tra tương phản trên nhiều nền; nền đặc là lựa chọn thực tế nếu chưa rõ giao diện nơi chia sẻ.

Vì sao tải lên rồi vẫn thấy ảnh xem trước cũ?

Trước tiên, xác minh ảnh mới đã được lưu vào đúng kho mã. Nền tảng chia sẻ có thể lưu ảnh xem trước trong bộ nhớ đệm; cách làm mới của chúng tách biệt với cài đặt kho mã.

Tài liệu tham khảo