名称

contrib - MRTGのためのコントリビューションガイド


要約

MRTGの機能拡張やバグ修正を書かれた場合は、プロジェクトへの協力を考えてください。毎週たくさんのコントリビューションを受け取るので、いろいろと追加の作業をせずにコントリビューションを使用できるように、どのようにコントリビュートするべきか説明したガイドラインを用意しました。


翻訳

MRTGメッセージは多くの言語に翻訳されています。しかしながらまだカバーされていないものがたくさんあります。もしあなたの(言語を)追加したいなら、 mrtg-2.9.22/translateディレクトリ下の READMEファイルにあるインストラクションに従ってください。


文書化

MRTGのドキュメンテーションはPerl POD システムを使用しています。これについて知りたい場合には

 perldoc perlpod

と入力し、インストラクションをお読みください。もし既存の文書にバグ修正の追記をする場合には、HTMLやtxtバージョンではなく PODファイルを修正するようにしてください。


パッチ

もしMRTGを修正や機能拡張を作成し提出したい場合には、自分で編集したファイルに対するパッチを作成してください。新規のものでない限り、ファイルを丸ごと送らないでください。

パッチを作成するにはGNU diffを使用して(ほとんどのUnixシステムにインストール済みです。NTを使用しているなら、素敵なGNUツールが使えるようにhttp://sources.redhat.com/cygwin/ を取得するといいでしょう)

 diff --unified --ignore-space-change old-file new-file > simple.patch

と入力してください。

もし複数のファイルを編集したなら

 diff --recursive --unified --ignore-space-change old-dir/ new-dir/ >long.patch

と入力して下さい。


文書化

私は文書化について真剣に考えています。公式リリースに入れたい新しい機能をMRTG用に作成した場合には、 docツリー下にある関連するPODcfgmaker や indexmakerのドキュメンテーションセクションの修正分がそのパッチに含まれている必要があります。


アドレス

パッチ、翻訳、コントリビューションはTobias Oetiker <oetiker@ee.ethz.ch>宛てにお送り下さい。


著者

Tobias Oetiker <oetiker@ee.ethz.ch>


日本語訳

橋本 理央 <e2j@mrtg.jp>