unshiu

最近の更新履歴

開発ルール‎ > ‎

外部プラグイン管理ルール


外部プラグインとは

社外、社内を問わずunshiuの機能plugin以外のpluginを「外部プラグイン」という扱いで定義します

svn

/unshiu/plugins
/plugin-name
/trunk
/tags
/branches
  • タグ付けのルール等はunshiu本体と同様とします
  • 案件で利用するものは必ずタグ付けをしたものとします。
  • 手を入れていないpluginに関しては独自管理しません。

前提

管理することにより、その手間が必要になり、かつ最新のプラグインへの更新の障害になります。以下の拡張基準にのっとり、可能な限り、本体には手を入れず、lib 以下でライブラリを上書きするなどして対応してください。

拡張基準

pluginに直接手をいれることが許される場合

  • 汎用的でかつ本体へフィードバックができるような機能追加
  • pluginのメンテナーが放棄し、1年以上動きがないようなものに対する修正
  • 全面的に修正しなければ機能追加や修正ができないような場合

libで上書きした方がよい場合

  • 次回バージョンアップで修正されうるような修正
    • railsのバージョン的な問題からうまれたもの
  • メソッドの上書きで簡易に修正が可能なもの
  • unshiu独特の機能のためunshiu以外の汎用性がないもの

管理ルール

外部プラグインへの修正をする際は以下のことを必ずしてください。

  • Redmineの「外部プラグイン」に報告
    • 修正内容
    • なぜ修正が必要なのか
    • 修正対象バージョン
    • 一時的な回避策なのか、機能追加なのか
  • 修正内容をプラグイン開発者にフィードバック
    • フィードバックまで終わらないと「完了」ステータスにすることは不可
    • フィードバックできないようなものは必ず修正記録に明記する
    • 実際にフィードバックが反映されたことが確認できたらそれもRedmin上で明記する
  • CHNGELOG、READMEを書く