Hacktoberfest 2026：メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Make a contribution guide

オープン
  • 何か問題がありますか？
#34 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
45/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
html, javascript, jekyll, ruby
領域
documentation

調査の方向性

まず _config.yml、_layouts、_sections、_wiki ディレクトリを確認し、続いてリンク先の Jekyll ドキュメントを参照します。コントリビューションガイドでは、issue に記載されているとおり、リポジトリの構造、画像の扱い、ファイル参照、レイアウト、サポート対象ブラウザー、JavaScript フォールバックについて説明してください。

索引モデルが issue の本文から書いたものです。

説明

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

主要言語
HTML
スター
40
フォーク
10
平均マージ
32分
マージ済み PR（30日）
4

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

OpenTabletDriver/opentabletdriver.github.io のほかの issue

OpenTabletDriver/opentabletdriver.github.io の issue をすべて見る

似ている issue

Documentation の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。