このウェブサイトは、Clojureプログラミング言語とそのエコシステムに関するコンテンツのオープンソースリポジトリであり、https://clojure.dokyumento.jpでホストされています。
サイトの問題点を指摘したり、新しいページを提案したい場合は、https://github.com/clojure/clojure-site/issuesでGitHub issueを作成してください。
貢献（タイプミス、修正、または新しいコンテンツ）を行いたい場合は、貢献者になり、下記の手順に従ってください。
貢献者は、変更を送信する前にClojure Contributor Agreementに署名する必要があります。Contributor Agreement (CA) は、Rich Hickeyと貢献者に共同著作権を与えます。貢献者は著作権を保持しつつ、オープンソースプロジェクトのスポンサーであるRich Hickeyにもその権利を付与します。
CAは、OpenJDK、NetBeans、OpenSolarisプロジェクトなどで使用されているOracle Contributor Agreement (OCA) を基にしています。多くの質問に答える優れたOCA FAQがあります。
CAを実行することにより、貢献者はClojureサイトのコンテンツを保護し、コミュニティの変化する要求にプロジェクトを適応させる柔軟性を保護します。CAを有効にするには、Clojureプロジェクトはすべての貢献に対して権利譲渡を取得する必要があります。CAの条項と条件を完全に理解するために、CAを確認してください。Clojureにソースコードまたはその他の資料を寄稿することにより、あなたは、そのような寄稿についてRich HickeyとのCAを締結していることを表明します。貢献者を追跡するために、あなたの氏名とユーザー名は、公開URLからアクセス可能な承認された貢献者をリストしたウェブページに掲載されることを理解してください。
契約を締結するには、Contributor Agreement（オンラインe-フォーム）に記入して提出してください。
Clojureソースコードへのパッチ提供のためにClojure Contributor Agreementに既に署名している場合は、同じ契約であるため、再度署名する必要はありません。
小さな変更は、GitHub Webインターフェースで直接提案できます。
コンテンツリポジトリhttps://github.com/clojure/clojure-siteにアクセスします。
content/の下で更新したいページに移動します。URLはファイルのベース名と一致する必要があります。たとえば、このファイルのコンテンツはhttps://github.com/clojure/clojure-site/blob/master/content/community/contributing_site.adocにあります。
編集（鉛筆）アイコンをクリックします。
コンテンツは、Markdownと同様のasciidoc形式で記述されています。編集ページには、このサイトのコンテンツを編集する際に遭遇する最も一般的な事項の例がリストされています。テキストボックスに変更を加えます。「変更のプレビュー」タブを使用して、変更をプレビューできます。GitHubはasciidoc形式を理解しており、変更のフォーマットされたプレビューを提供します。
ページの下部にあるセクションに変更の概要を簡潔に記述し、「ファイル変更を提案」をクリックします。これにより、元のレポジトリが変更が適用されたレポジトリの独自のバージョンにフォークされます。
次に、「変更の比較」ページが表示されます。すべての情報は自動的に入力され、変更のサマリーが下部に表示されます。これは、もう一度確認するのに最適なタイミングです。すべてが正しい場合は、「プルリクエストの作成」をクリックして、変更を元のレポジトリに提案できます。その後、プルリクエスト自体にコメントを追加して、「プルリクエストの作成」をクリックできます。
| 大きな変更については、まずissueを開き、時間をかける前に変更について話し合ってください。 |
まったく新しいページを作成する場合、または複数のコミットが必要な大きな変更を行う場合は、コマンドラインツールを使用する方が簡単です。
大きな変更に取り組むためのローカル環境を作成するには
コンテンツリポジトリhttps://github.com/clojure/clojure-siteをフォークします。これにより、独自のユーザーIDの下にサイトコンテンツのバージョンが作成されます。
ローカルターミナルでフォークされたリポジトリを`git clone`し、`cd clojure-site`します。
`git checkout -b <branchname>` - 変更に取り組む新しいブランチを作成します。このブランチを使用してプルリクエストを送信します。
このブランチで1つ以上のコミットを行い、1つ以上のファイルを修正または追加します。ローカルで変更をビルドしてプレビューする方法については、以下のセクションを参照してください。編集ページには、このサイトのコンテンツを編集する際に遭遇する最も一般的な事項の例がリストされています。
`git push`を使用して変更をブランチにプッシュします。
https://github.com/username/clojure-site/tree/branchnameにアクセスします。
緑色のボタン「比較、レビュー、プルリクエストの作成」をクリックし、プロンプトに従ってプルリクエストを送信します。
サイトに積極的に貢献するには、独自のフォークをこのリポジトリと最新の状態に保つことが重要です。そのためには
このリポジトリをリモートURLに追加します。`git remote add upstream https://github.com/clojure/clojure-site.git`。
すべての貢献の前に
アップストリームのコンテンツを取得します。`git fetch upstream`;
マスターブランチに移動します。`git checkout master`（まだそこにない場合）。
取得したブランチにHEADをリセットすることで、計画外の変更をマスターブランチからクリーンアップします。`git reset --hard upstream/master`;
上記のように新しいブランチを作成します。`git checkout -b <branchname>`
大きな変更に取り組む場合は、ローカルでサイトをビルドすると便利です。サイトはJBakeを使用してビルドされています。
JBake 2.6.5をインストールするには
`curl -L -O https://dl.bintray.com/jbake/binary/jbake-2.6.5-bin.zip`（またはブラウザでこのファイルをダウンロードします）
unzip -o jbake-2.6.5-bin.zip
jbake-2.6.5-bin/binをシステムのPATHに追加します。
サイトをビルドするには
コンテンツを取得します
`git clone https://github.com/clojure/clojure-site.git`（または独自のフォーク）
cd clojure-site
現在のテーマアセットを取得してインストールします（これらは頻繁に変更されるわけではないため、毎回実行する必要はありません）。
`curl -O https://clojure.dokyumento.jp/clojuretheme.zip`（またはブラウザでこのファイルをclojure-siteディレクトリにダウンロードします）
unzip -o clojuretheme.zip
ページを生成します
`jbake -b` - これにより、出力ディレクトリに静的サイトが作成されます。
静的ファイルを表示するには、ブラウザで`output/index`を開きます。
ライブプレビューを表示するには、`jbake -s`を実行し、https://:8820/indexにアクセスします。
現在、サイト全体のスタイル、ナビゲーション、またはインフラストラクチャの変更は求めていません。その分野では現在進行中の作業があり、近いうちに公開される予定です。
これらの領域に問題がある場合は、プルリクエストではなく、issueを開いてください。
プルリクエストを送信した後、貢献はレビュー待ちになります。
各プルリクエストに対して、1人以上のレビューアーが対応します。
コメントに「Reviewed」ラベルを付けます。これは、レビューアーが変更を承認し、エディターにそれらの変更をマージするよう要求することを示します。
追加の変更を提案するコメントをプルリクエストに追加します。ローカルブランチでさらにコミットを行い、これらの変更に対応できます。
変更が適切ではない理由を示すコメントを付けて、プルリクエストを閉じます。
Copyright © 2019 Rich Hickey and contributors
このリポジトリに含まれるすべてのドキュメントは、特に明記されていない限り、Rich HickeyによってEclipse Public License v1.0 のもとでライセンスされています。
