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

Make a contribution guide

Đang mở
  • Có gì không ổn?
#34 0 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
45/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
html, javascript, jekyll, ruby
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu bằng cách xem xét _config.yml, các thư mục _layouts, _sections và _wiki, sau đó tham khảo tài liệu Jekyll được liên kết. Hướng dẫn đóng góp cần giải thích cấu trúc repository, cách xử lý hình ảnh, các tham chiếu tệp, layouts, các trình duyệt được hỗ trợ và các JavaScript fallbacks như được mô tả trong issue.

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

Mô tả

enhancement meta

Should cover things like:

  • Image optimization BEFORE commit
    • https://imageoptim.com/versions.html or similar
    • This is to avoid making a git clone be needlessly large. Committing one version and then later committing an optimized version still ends up with both versions in the git repo. Rewrite your commits to fix this (git rebase -i origin/main and follow instructions)
  • Image usage
    • <picture> preferring webp with png fallback?
  • Suggest the contributor to read the Jekyll docs: https://jekyllrb.com/docs/ but also write the guide assuming contributors have not read this thoroughly, for now.
  • Referencing other files (using {% link %} etc)
    • It's a compile-time file check, basically
  • Site structure
    • What goes where and what's what
      • /assets/: generic site assets
      • /_sections/: pages that get their title assigned to the website root, e.g. /_sections/blarg.md with title: Test in front matter gets http://site/Test as permalink, but try to keep file name (and casing) consistent with the title used.
      • /_wiki/: uses the path of the file as permalink and defaults to the wikipage layout, e.g. _wiki/Install/Linux.md becomes https://site/Install/Linux
      • Generic Jekyll files:
        • /_config.yml: main Jekyll config, see Configuration | Jekyll
        • /index.md: frontpage content, see front matter for which layout is used
        • /404.html: the 404 (page not found) page used
        • /Gemfile (and Gemfile.lock): ruby files used by rubygems and bundler, see Ruby(?) docs.
      • Generic folders:
        • /_data/: data accessible via {{ site.data }}, see Data Files | Jekyll
        • /_includes/: files used in {% include <file> %} statements, see Includes | Jekyll
        • /_layouts/: files used for layouts, inheritance is heavily used here, see Layouts | Jekyll
        • /_site/: Contains the processed/built site. Should never be in VCS/git.
        • vendor: Your local ruby files. Should never be in VCS/git.
    • What happens in different folders (collections array in /_config.yml tells us most of that)
    • Detail usage of /_layouts
      • also mention that wiki collections (/_wiki files) always use the wikipage layout, anything else uses the default layout, and inheritance is used (e.g. layout wikipage defining default as its layout, which replaces {{ content }} in default with wikipage contents) (link to Jekyll docs for layouts)
  • Target browsers (Chrome and Firefox, both on Mobile and Desktop - if Chrome works most things should work)
  • Usage of JavaScript
    • Keep to a minimum, but if you have to use it, always consider noscript/no-JS users - at the very least, have a scriptless fallback.

Additions welcome

Ngôn ngữ chính
HTML
Star
37
Fork
10
Merge trung bình
32 phút
Pull request đã merge (30 ngày)
4

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

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 OpenTabletDriver/opentabletdriver.github.io

Tất cả issue của OpenTabletDriver/opentabletdriver.github.io

Issue tương tự

Thêm issue về Documentation

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.