コントリビューションと改善にご協力ください
翻訳者を募集! 皆のためにこの仕様書の翻訳を手伝ってくれる翻訳者を探しています!
slackワークスペースで作業しています。気軽に参加してください!
All-contributorsドキュメントの改善にご協力ください!
このプロジェクトに興味を持っていただいてありがとうございます! 小さな誤植から新しいセクションの執筆まで、あらゆるレベルの改善のためのpull requestを歓迎しています!プロジェクトの改善にご協力ください。
全ソースコードは、github.com/all-contributors/all-contributorsからアクセスできます
新しいコントリビュータのオンボーディング
私たちは新しいコントリビュータの人にオンボーディングを提供しています。もし参加したい場合にはSlackチャンネルでコメントしてください。
All-contributorsリポジトリへのコミット
私たちはchangelogを自動生成するために、angularコミットメッセージガイドラインを利用していますので、このガイドラインに従ってください。 ガイドラインに慣れていない場合やコミットの入力をミスしそうなら、npm run commit
やgit cz
(commitizen
をインストールしている場合) を実行すれば、いくつかの質問を通してコミットを生成してくれます。
コンテンツの編集
ヒント: 各ページ上部にある、編集ボタンをクリックすると、そのページのGitHubソースコードへ直接遷移します。
ファイルの'鉛筆'アイコンをクリックすると、簡単にファイルをインラインに編集することができます
翻訳
私たちの翻訳は、crowdinで管理されています。 crowdinプロジェクトで翻訳を提案して、コントリビューションを行うことができます。 ご希望の場合は、このissueにコメントしてご協力いただけることをお知らせください!質問でもかまいません。
When translating, it's important that anything that has the XPATH
@href
,@src
etc should not be translated.code
も同様です。 これはプロジェクトが404エラーになります。 以下の画像の例を参照してください:ただし、
code
タグ内のコメントなど、理解しやすくなるような内容であれば、英語で書かれた実際のコードを変更しない限りは、翻訳をおすすめします。
手引き
Crowdin にログイン
- crowdinプロジェクトに移動し、サインアップしてログイン。
- "All Contributors"プロジェクトに参加し、ほら、出来上がり!
原文を翻訳
- Crowdinプロジェクトに移動します。
- ドキュメントを翻訳したい言語のフラッグをクリックします。
- 完全には翻訳されていない
*.md
ファイルをクリックします (右部の100%表示を確認してください) - "Enter translation here"フィールド (上部にある"SOURCE STRING"の文字列の翻訳に対応します) に翻訳を入力し、"SAVE"をクリックします
- 校正者のみ: 翻訳の修正候補(自分のものでも他人のものでも)を承認するには、"[LANGUAGE] TRANSLATIONS"セクションにある :ballot_box_with_check: をクリックするか、 :wastebasket: アイコンをクリックして修正候補を削除します。
デプロイメントを変更
特定の言語で文字列を翻訳した後は、master
ブランチが更新されてデプロイが成功するまで、それらの変更は反映されません。
検索
検索はalgoliaによるもので、設定はhttps://github.com/algolia/docsearch-configs/blob/master/configs/all-contributors.jsonにあります
サイトをローカルで実行する:
All Contributorsは、ドキュメントのWebサイトの整備にDocusaurusを使用します。 詳細はDocusaurus Webサイトをご覧ください
ローカルで開発する:
yarn install
yarn start
- ブラウザで
http://localhost:3000
を開く (変更を反映するにはページを更新します)
コントリビューターとして自身を追加する
自身をコントリビューターテーブルに追加するために、botの使い方に従ってください ;)