公開の準備をする


トラックを公開する前に、次の作業がすべて完了していることを確認してください。

トラックのアイコンを依頼する

サイト用のアイコンをデザインするには、exercism/website-iconsリポジトリで新しいissueを作成し、次の質問に答えてください。

  • その言語に公式のロゴはありますか? ある場合は
    • 例へのリンクを記載してください
    • 帰属表示の要件と、そのロゴの使用が認められる権利を挙げてください
  • その言語に非公式のロゴはありますか? ある場合は
    • その非公式ロゴがどのように使われているかを説明してください
    • 例へのリンクを記載してください
    • そのロゴの帰属表示の要件を挙げてください

トラックのドキュメントを追加する

次のトラックドキュメントを追加してください。

  • docs/ABOUT.md:その言語の簡単な紹介。
  • docs/INSTALLATION.md:学習者がCLIを使ってローカル環境でトラックに取り組めるようにするために、何をインストールする必要があるかを説明します。
  • docs/LEARNING.md:学習リソースへのリンク。
  • docs/RESOURCES.md:役立つリソースへのリンク。
  • docs/TESTS.md:トラックでテストを実行することに関するあらゆることを説明します。

これらのドキュメントは、学習者がトラックを始める助けになるとともに、トラックとその言語について学ぶのにも役立ちます。 詳しくはドキュメントの説明を参照してください。

演習のドキュメントを追加する

次の演習ドキュメントを追加してください。

  • exercises/shared/.docs/help.md:助けを求める方法についてのトラック固有の説明が含まれます
  • exercises/shared/.docs/tests.md:テストの実行方法についてのトラック固有の説明が含まれます

コードスニペットを追加する

docs/SNIPPET.txtファイルにコードスニペットを追加してください。 このスニペットは、その言語の構文がどのようなものかを視覚的に伝えます。 詳しくはドキュメントの説明を参照してください。

メタデータを更新する

トラックのメタデータはconfig.jsonファイルで定義します。 次のプロパティを更新する必要があります。

  • language:トラックの言語(例:"C#")。長さは255以下でなければなりません
  • slug:トラックの言語を小文字のケバブケースにした文字列(例:"csharp")。長さは255以下でなければなりません
  • blurb:その言語の短い説明。長さは400以下でなければなりません
  • online_editor:オンラインエディターで使われる設定を記述するオブジェクト:
    • indent_style:"space"または"tab"のいずれか
    • indent_size:整数で表したインデントのサイズ(例:4)
    • highlightjs_language:Highlight.jsの言語識別子(識別子の一覧を参照してください)。Highlight.jsが対応していない場合は、このフィールドを省略できます。
  • key_features:その言語の主要な機能を簡潔に説明する項目です。詳しくは、主要な機能のドキュメントを確認してください。
  • tags:このトラックに当てはまるタグを定義します。これにより、ウェブサイト上でトラックを検索できるようになります。詳しくは、対応しているタグの一覧とあわせてタグのドキュメントを確認してください。