Home

翻訳者になる方法

前提として uniba/hamldoc_ja にコミットできる権限が必要です。

$ git clone git@github.com:uniba/hamldoc_ja.git
$ cd hamldoc_ja
$ make me-translator

翻訳対象のドキュメントはソースコード内に記述されています。英文のドキュメントは消さずに翻訳ドキュメントを追加してください。(詳しいやり方を後で書く。)

本家から最新のコードをマージする方法

master ブランチにいる状態で以下のコマンドを実行すると nex3/haml の最新のコードをマージできます。本家の更新に追随する必要が出たときに実行してください。

$ git pull upstream master

コンフリクトが起きたらいい感じに修正してください。

ドキュメントを生成する方法

ソースコード内のコメントから yard コマンドでドキュメントを生成します。

$ make docs

yard コマンドが見つからない場合は RubyGems から yard と maruku をインストールしてください。

$ sudo gem install yard maruku

ドキュメントを公開する方法

master ブランチにて make doc で生成したドキュメントを gh-pages ブランチにコピーして push します。

$ make publish