ClojureScript

このサイトへの貢献

このウェブサイトは、ClojureScriptプログラミング言語とそのエコシステムに関するコンテンツのオープンソースリポジトリであり、https://clojurescript.dokyumento.jp でホストされています。

サイトの問題を指摘したり、新しいページを提案したりする場合は、https://github.com/clojure/clojurescript-site/issues にGitHubのIssueを提出してください。

貢献(誤字脱字、修正、または新しいコンテンツ)を行う場合は、貢献者になり、以下のプロセスを使用する必要があります。

貢献者になる方法

貢献者は、変更を提出する前に、Clojure貢献者契約書に署名する必要があります。貢献者契約書(CA)は、Rich Hickeyと貢献者に共同著作権を与えます。貢献者は著作権を保持しながら、オープンソースプロジェクトのスポンサーであるRich Hickeyにも著作権を付与します。

CAは、OpenJDK、Netbeans、OpenSolarisプロジェクトなどで使用されているOracle貢献者契約書(OCA)から派生しています。多くの質問に答える良いOCA FAQがあります。

CAを実行することにより、貢献者はClojureScriptサイトのコンテンツを保護し、コミュニティの変化する要求にプロジェクトを適応させる柔軟性を保護します。CAを有効にするには、ClojureScriptプロジェクトはすべての貢献の譲渡を取得する必要があります。CAの条件をよく理解するために、CAを確認してください。ClojureScriptにソースコードまたはその他の資料を貢献することにより、あなたは、そのような貢献についてRich HickeyとCAを締結していることを表明します。貢献者を追跡するために、あなたの氏名とユーザー名が、公開URLからアクセスできる承認された貢献者をリストしたWebページに掲載される場合があることを理解しています。

契約を完了するには、貢献者契約書(オンラインの電子フォーム)に記入して送信してください。

ClojureScriptソースコードにパッチを提供するためにClojure貢献者契約書に既に署名している場合は、同じ契約書であるため、再度署名する必要はありません。

小さな変更の提出

小さな変更は、GitHubのWebインターフェースで直接提案できます。

  1. コンテンツリポジトリhttps://github.com/clojure/clojurescript-siteにアクセスしてください。

  2. content/の下で更新したいページに移動します。URLはファイルのベース名と一致する必要があります。たとえば、このファイルのコンテンツはhttps://github.com/clojure/clojurescript-site/blob/master/content/community/contributing_site.adocにあります。

  3. 編集(鉛筆)アイコンをクリックします。

  4. コンテンツは、Markdownに似たasciidoc形式で記述されています。編集ページには、このサイトのコンテンツを編集する際に遭遇する最も一般的な事柄の例が示されています。テキストボックスに変更を加えます。「変更のプレビュー」タブを使用して変更をプレビューできます。GitHubはasciidoc形式を理解し、変更のフォーマットされたプレビューを提供します。

  5. ページの下部セクションに変更内容の簡単な説明を書き、「ファイル変更の提案」をクリックします。これにより、元のレポジトリが変更が適用されたあなた自身のバージョンのレポジトリにフォークされます。

  6. 次に、「変更の比較」ページが表示されます。すべての情報が自動的に入力され、変更の概要が下部に表示されます。これは、もう一度確認するのに適した時期です。すべてが正しいように見えると仮定して、「プルリクエストの作成」をクリックして、元のレポジトリに変更を提案できます。その後、プルリクエスト自体にコメントを追加してから、「プルリクエストの作成」をクリックできます。

大きな変更の提出

大きな変更については、**必ず**最初にIssueを開き、時間をかける前に変更について話し合ってください。

完全に新しいページを作成する場合、または複数のコミットを必要とする重要な変更を行う場合は、コマンドラインツールを使用して作業する方が簡単な場合があります。

より大きな変更に取り組むためのローカル環境を作成するには

  1. コンテンツリポジトリhttps://github.com/clojure/clojurescript-siteをフォークします。これにより、独自のユーザーIDの下にサイトコンテンツのバージョンが作成されます。

  2. ローカルターミナルでフォークされたリポジトリをgit cloneし、cd clojurescript-siteします。

  3. git checkout -b <branchname> - 変更に取り組むための新しいブランチを作成します。このブランチを使用してプルリクエストを送信します。

  4. このブランチで1つ以上のコミットを行い、1つ以上のファイルを変更または追加します。変更をローカルでビルドおよびプレビューする方法については、以下のセクションを参照してください。編集ページには、このサイトのコンテンツを編集する際に遭遇する最も一般的な事柄の例が示されています。

  5. git pushを使用して変更をブランチにプッシュします。

  6. https://github.com/username/clojurescript-site/tree/branchnameにアクセスしてください。

  7. 緑色のボタンをクリックして「比較、レビュー、プルリクエストの作成」を行い、プロンプトに従ってプルリクエストを送信します。

サイトに積極的に貢献するには、独自のフォークをこのリポジトリで最新の状態に保つことが重要です。そのためには

  1. このリポジトリをリモートURLに追加します:git remote add upstream https://github.com/clojure/clojurescript-site.git

  2. すべての貢献の前に

    • アップストリームのコンテンツをフェッチします:git fetch upstream;

    • マスターブランチに移動します:git checkout master(まだそこにいない場合);

    • フェッチされたブランチにHEADをリセットすることにより、マスターブランチから計画外の変更をクリーンアップします:git reset --hard upstream/master; そして

    • 上記のように新しいブランチを作成します:git checkout -b <branchname>

変更のビルドとプレビュー

大きな変更に取り組む場合は、サイトをローカルにビルドすると役立ちます。サイトはJBakeを使用してビルドされています。

JBake 2.5.0-SNAPSHOTをインストールするには

  1. curl -O http://cdn.cognitect.com/clojurescript.org/jbake-2.5.0-SNAPSHOT-bin.zip (またはブラウザでこのファイルをダウンロードします)

  2. unzip -o jbake-2.5.0-SNAPSHOT-bin.zip

  3. jbake-2.5.0-SNAPSHOT/binをシステムPATHに追加します

サイトをビルドするには

コンテンツを取得します

  1. git clone https://github.com/clojure/clojurescript-site.git (または独自のフォーク)

  2. cd clojurescript-site

現在のテーマアセットを取得してインストールします(これらはあまり変更されないため、毎回これを行う必要はありません)

  1. curl -O https://clojurescript.dokyumento.jp/cljstheme.zip (またはブラウザでこのファイルをclojurescript-siteディレクトリにダウンロードします)

  2. unzip -o cljstheme.zip

ページを生成します

jbake 2.5.0にはJava 8が必要です。(Java 9では正しく動作しません。)

  1. jbake - これにより、outputディレクトリに静的サイトが作成されます

  2. 静的ファイルを表示するには、ブラウザでoutput/indexを開きます

  3. ライブプレビューを表示するには、jbake -sを実行し、https://:8820/indexにアクセスします

スタイルとナビゲーションの変更

現在、サイト全体のスタイル、ナビゲーション、またはインフラストラクチャの変更は求めていません。その分野では現在進行中の作業があり、近い将来に公開される予定です。

これらの分野に問題がある場合は、プルリクエストではなくIssueを開いてください。

貢献のレビューとデプロイ方法

プルリクエストを送信した後、貢献はレビューを待ちます。

各プルリクエストについて、1人以上のレビューアーがアクションを実行します

  • コメントにReviewedラベルを付けます。これは、レビューアーが変更を承認し、エディターにそれらの変更をマージするように要求することを示しています。

  • 追加の変更を提案するプルリクエストにコメントします。ローカルブランチでさらにコミットを行うことで、これらの変更に対処できます。

  • 変更が適切でない理由を示すコメントとともにプルリクエストを閉じます。

ありがとう!

ご協力ありがとうございます!

利用規約

Copyright © 2015 Rich Hickey and contributors

このリポジトリに含まれるすべてのドキュメントは、特に明記されていない限り、Rich HickeyによってEclipse Public License v1.0の下でライセンスされています。