10分で貢献する
AILmanac が「網羅的で常に最新」でいられるのは、あなたのような人が内容を追加してくれるからです。開発者である必要はありません — 誤字の修正、用語集への項目追加、テンプレートの共有はすべて立派な貢献です。
最短ルート
- サイトで該当ページを見つけ、ページ下部の**「Edit this page」**をクリックします(GitHub 上でファイルが開きます)。
- ✏️ 鉛筆アイコンをクリックしてブラウザ内で編集します。GitHub が自動でリポジトリをフォークしてくれます。
- Markdown で変更を加えます。
- 下部で短い説明を書き、propose changes → open a pull request を選びます。
- メンテナーがレビューします。これで完了です。🎉
ローカルで作業したいですか? リポジトリをクローンして次を実行します。
npm install
npm run start # live preview at http://localhost:3000
npm run build # must pass: it fails on broken links
すべてのページが守る4つのルール
これらを守るとレビューが速くなり、品質も高く保てます。
- レベルを示す。 本文の冒頭を
<LevelBadge level="beginner" />(またはintermediate/advanced/all)で始めます。 - 変動しやすい事実には出典をリンクする。 モデル名、価格、制限、機能など変化するものはすべて公式ページを引用し、
<VerifyNote lastVerified="YYYY-MM-DD" source="..." />を使ってください。モデルに関する事実をハードコードせず、モデルテーブルへリンクします。 - 主張を持ち、そして正直に。 まず推奨する方法を示し、代替案にも触れます。公式ドキュメントを複製せず、そこへリンクしてください。
- 平易な言葉、理論より実例。 短い文で。説明だけでなく、見せましょう。
ページのフロントマターのテンプレート
---
sidebar_position: 2
title: Your Page Title
description: One sentence shown in search and previews.
keywords: [relevant, search, terms]
---
<LevelBadge level="beginner" />
Your first paragraph...
良い初めての貢献とは
- 不足している用語集の項目を追加する。
- すでに使っているテンプレートやプロンプトを追加する。
- 新たにリリースされたことで、あるページの記述が誤りになった箇所を修正する(そして
lastVerified日付を更新する)。 - ページを翻訳する — 翻訳プレイブックを参照してください。
ライセンスとサインオフ
貢献することで、あなたの文章は CC BY 4.0 の下で、コードは MIT の下で共有されることに同意したことになります。また、コミットに Signed-off-by 行(DCO)を追加してください(git commit -s)。詳細はガバナンスのページにあります。
親切に — 私たちは Contributor Covenant の行動規範に従っています。