Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Document best practices when adding images to documentation

Đang mở
#153 1 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
35/100
Loại issue
Tài liệu
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Đình trệ
Lĩnh vực
cli, documentation

Hướng nghiên cứu

Không có tệp, bài kiểm thử hay điểm vào CLI nào được nêu; hãy bắt đầu bằng cách xác định phần tài liệu về hình ảnh và mọi công cụ hiện có để giảm kích thước hình ảnh. Công việc được xem là hoàn tất khi tài liệu bao quát việc lựa chọn định dạng, giảm kích thước, sử dụng pre-commit và đặt tên, đồng thời mô tả rõ hành vi và cách sử dụng của lệnh CLI được yêu cầu.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

images

Some obvious steps would be:

  1. Document how to choose an appropriate image format (JPG, PNG).
  2. Add CLI command that automatically reduces size of images.
  3. Document how to apply it before adding images to git history.
  4. Document how to sensibly name images.
Ngôn ngữ chính
TypeScript
Star
15
Fork
46
Merge trung bình
1 ngày 21 giờ
Pull request đã merge (30 ngày)
1

Hướng dẫn đóng góp

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của oasisprotocol/docs

Tất cả issue của oasisprotocol/docs

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.