貢献するには

ウェブサイトに対する貢献

http://linuxmint-jp.net/ 以下に含まれるコンテンツは github 上のリポジトリで管理されています。コンテンツに修正を加えたい場合は、以下の文書に目を通してください。また、重要かつ大掛かりな修正を行う場合は事前に linuxmint-jp-www@linuxmint-jp.net でその内容を議論してください。

リポジトリのコピーを取る

git リポジトリのコピーを取るには clone または pull します。

始めてコピーを取る場合、プロジェクトの git リポジトリを clone します。コンテンツは WebSite ディレクトリの下に含まれています。

$ git clone git://github.com/linuxmintjapan/WebSite.git
Cloning into WebSite...
remote: Counting objects: 141, done.
remote: Compressing objects: 100% (109/109), done.
remote: Total 141 (delta 29), reused 140 (delta 28)
Receiving objects: 100% (141/141), 7.87 MiB | 856 KiB/s, done.
Resolving deltas: 100% (29/29), done.
$ cd WebSite

リポジトリに直接 commit するなどの理由で読み書き可能なリポジトリを clone する場合は以下のようにします。リポジトリに対して読み書きを行うにはメンバーの登録が必要です。

$ git clone git@github.com:linuxmintjapan/WebSite.git
Cloning into WebSite...
Enter passphrase for key '****************************':
remote: Counting objects: 141, done.
remote: Compressing objects: 100% (109/109), done.
remote: Total 141 (delta 29), reused 140 (delta 28)
Receiving objects: 100% (141/141), 7.87 MiB | 1.08 MiB/s, done.
Resolving deltas: 100% (29/29), done.
$ cd WebSite

すでにコピーを持っている場合 (過去に clone を行っている場合)、コピーの内容が最新版であることを確認するために pull します。コンフリクトが起きた場合は適宜コンフリクトを解消してください。

$ git pull origin
Already up-to-date.

コンテンツの修正

コンテンツに修正を加えます。編集して (例 1 では sed -i、例 2 では vi)、編集したファイルを index に追加して (git add)、編集内容の説明を付けて index の内容をコミットします (git commit)。

例 1: *.html にマッチするファイルのコピーライト部分に文字参照 © を使うように修正

$ sed -i -e 's/Copyright c 2012/Copyright \&copy; 2012/g' *.html
$ git add *.html
$ git commit -m "use copyright entity"
[master 898456f] use copyright entity
 10 files changed, 10 insertions(+), 10 deletions(-)

例 2: community.html と contact.html を適当に修正

$ vi community.html contact.html
$ git add community.html contact.html
$ git commit -m "describe what you did"
[master f3f42fd] describe what you did
 2 files changed, 2 insertions(+), 4 deletions(-)

修正内容の反映

修正内容を反映させるには 3 つの方法があります。linuxmint-jp-www@linuxmint-jp.net 宛に patch を送信して commit を依頼する方法と、リポジトリに直接 commit する方法、github 上でプルリクエストを作成する方法です。

commit を依頼する場合、linuxmint-jp-www@linuxmint-jp.net に patch を送信します。送信する patch は以下のように作成します。メールには base64 でエンコードされた添付ファイルとして patch を添付します (インラインテキストで送信する事により意図せずにエンコーディングが変わる事を防ぐため)。patch の内容はチェックの後にリポジトリに取り込まれます。

$ git format-patch origin
0001-use-copyright-entity.patch
0002-describe-what-you-did.patch

リポジトリに直接 commit する場合、以下のようにします。これを行うにはリポジトリの読み書き権限が必要です。

$ git push origin

origin リポジトリの URL が読み書き可能なものでない場合、以下のように push に失敗します。

$ git push origin
fatal: remote error:
  You can't push to git://github.com/linuxmintjapan/WebSite.git
  Use git@github.com:linuxmintjapan/WebSite.git

github 上でプルリクエストを作成して修正内容の反映を依頼することもできます。詳しくは Using pull requests を参照してください。

github のリポジトリに取り込まれた内容は 6 時間毎にサイト上に反映されます。

git リポジトリの読み書きができるメンバーの登録申請

リポジトリの読み書きを行うにはリポジトリに対して github アカウントの紐付けが必要です。メンバー登録申請を行うには以下の情報を明記して linuxmint-jp-www@linuxmint-jp.net 宛にメールを送信してください。

登録済み Linux Mint Japan メンバー名
github アカウント

Web ページ編集ルール

html ファイルのドキュメントタイプは html5 で Polyglot Markup: HTML-Compatible XHTML Documents スタイルで書いてください。表記例は A Sample Page Using Polglot Markup 等の文書を参照してください。
The W3C Markup Validation Service や Unicorn 等のツールで構文に間違いが無い事を確認してください。
無意味な p タグ (単独の <p></p> 等) や無意味な div タグ (外側の入れ子に意味が無い <div><div></div></div> 等) を含めないでください。
単色や単純な模様や文字は画像ではなく CSS による表現を模索してください。
不適当な文書構造 (h* タグを見出し以外の場所に使うなど) は止めてください。

日本語スタイル

英単語と日本語の間に半角の white space を入れてください。
半角で書ける内容を全角で書かないでください (全角英数字等)。