HowToContribute

より気軽にプロジェクトに貢献する方法を説明します。

資格

特に必要ありません。日本語を扱えるとよいです。英語はできればすごく便利ですが必須ではありません。

また、 Ruby でプログラミング出来るとサンプルの検証などもできるのですごく便利ですが、必須ではありません。

貢献方法

プロジェクトに貢献するための方法がいくつかあります。

プロジェクトに参加する

HowToJoin を参照して参加してください。

ドキュメントの誤り・改善点を指摘する

このプロジェクトにIssueを登録してください。

Issueを登録する際は、最新版で修正済かどうか確認してください。また、 unified diff の形式で報告すると、修正を適用するのが楽なのでチャレンジしてみてください。さらに、rurema/doctreeへのPull Requestだとより修正を適用するのが楽です。なお、そうでないツッコミでも OK です。

より具体的には以下のようなことを期待しています。

• ドキュメントの単純な誤り指摘 (バージョン間違いなど)
• ドキュメントをよりよくするための提案 (説明文追加など)
• あるメソッドのサンプルコード提供
• 既に上がっているIssueに対するコメント

Tutorial, HowToReport も参照してください。

ツールを作成する

未完了のIssueに対応するツールを作成してくれる人を募集しています。

「るりま」を宣伝する

ブログや勉強会などで「るりま」を宣伝してください。