開発時のルール等についてまとめています。

PullRequestルール ✅

  • 修正対象: 基本的にどんなものでも大丈夫です
    • 英語になっているページの翻訳
    • わかりにくい文章・翻訳を改善( 元の翻訳は一切気にせずよりわかりやすいと思う訳をご提案ください
    • typoの修正
    • 元ドキュメントの修正への追従(後述の反映済みコミットの章を参照)
  • ルール: 特にありません
    • タイトル・説明・コミットメッセージ等は日本語で作成していただいて大丈夫です。記法に指定はありません。
  • 方針
    • 原文を直訳するよりも、多少情報が落ちる・変更されるとしても意訳して読みやすくしたほうがいいと思っています。

開発方法 💻

jekyll がインストールされている必要があります(公式のインストールガイド) ※ jekyll-redirect-from, jekyll-feed, jekyll-sitemap のgemがインストールされていないとエラーになります(例えばgem install --user-install bundler jekyll-redirect-fromといったコマンドでインストールしてください)

./develop.sh を実行後 localhost:4000 で修正中のドキュメントが閲覧できます。

反映済みコミット

※メンテナンスしてくれる人向け情報

別ページにまとめています