Mahara日本語ドキュメント/開発者エリア/Maharaプロジェクト概要

作成中です - mits

このページではMaharaプロジェクトの開発手順概要に関して説明します。

• コードの技術的詳細は次をご覧ください: Developer_Area/Mahara_Architecture_Introduction
• Maharaに貢献するための他の方法は次をご覧ください:Maharaに貢献する

誰がMaharaを所有していますか? (Who owns Mahara?)

MaharaはGPL3ライセンスの下、オープンソースソフトウェアとして配布されています。これは標準的な意味での「所有者」が存在しないことを意味します。Maharaのコピーを持っている人は許可を得ずに「誰でも」使用すること、修正すること、再配布すること、自分でフォークしたプロジェクトでさえ開始することができます (Maharaには技術的に個々のコードを書いている法人および開発者の著作権がありますが、GPL3ライセンスの下で配布される限り、著作権保持者は誰でもコードを使用、修正および再配布することに同意すると謳っています。これは基本的に「コピーレフト」が意味するものです)

これに関する1つの例外が「Mahara商標 (Mahara trademark) 」です。Maharaの名称およびロゴは商標であり、特定の環境下で使用する場合には許可を必要とします (例 ドメインおよび商用利用)。詳細は私たちの商標ポリシーをご覧ください。

誰がMaharaを作っていますか? (Who makes Mahara?)

• Catalyst IT (http://catalyst.net.nz) はMaharaプロジェクトを創出した法人であり、その開発をリードしています。Catalystは https://mahara.org を主催しています。また、小規模のフルタイムのMahara開発者 (しばしばMahara HQと呼ばれます) が管理およびほとんどのMaharaリリース頻度を管理しています。
• Maharaコントリビュータ (貢献者) はMaharaを改良して、その改良をコミュニティと共有する人すべてです。貢献者の中にはMaharaを使用している学校または大学も含みます。その他の貢献者にMaharaインストールのサポートを提供しているCatalystのような法人があります。そしてまた、貢献者としてMaharaの熱心なユーザも存在します。貢献者は個人のバグ修正からサイト全体の機能強化に及びます。

• 一般のメンバーの方もコントリビュータ (貢献者)として歓迎します。
  • Maharaに興味のある方は誰でも気軽に参加することのできるMaharaコントリビュータグループもLaunchpad上にあります。
    • このグループにはMahara bug trackerのためのバグ管理者権限があります。そのため、バグステータスを設定したり、バグをマイルストーンにピン留め等するには、あなたはこのグループに入る必要があります。
  • 他のコントリビュータのパッチを「+1 レビュー済み」および検証済みと評価するために、誰でも https://reviews.mahara.org の「Maharaテスター」グループに参加することができます。IRCまたはmahara.orgフォーラムでお尋ねください。

• Maharaコア開発者 (別名 Maharaレビュア) は「+2レビュー」およびMaharaコードレビューシステムにコミットアクセスできるユーザです [1]。Maharaコードの品質を保証するため、すべてのコントリビューション (寄贈コード) はコード作者ではない信頼できるレビュアによってレビューおよびコミットされます。
  • レビュアになるための手順は次のとおりです: Developer_Area/Commit_Policy#Becoming_a_reviewer
  • gerritグループに加えて、Launchpad上でのMaharaプロジェクト管理を担当するLaunchpad「Mahara Reviewers」があります: https://launchpad.net/~mahara-reviewers

• Mahara セキュリティチームはセキュリティ問題をレビューするMaharaレビュア内のグループです。
  • 信頼できるすべての認証MaharaレビュアはMaharaセキュリティチームへの参加を歓迎します。

• Mahara翻訳者はMahara本体の翻訳およびユーザマニュアルを他の言語に翻訳している人々です。
  • Mahara翻訳者は自分が参加している言語に関するLaunchpad上の翻訳グループへの参加を招待されます。

Maharaバージョン (Mahara versions)

詳細は6MonthlyCycleをご覧ください。

Mahara 1.5から始まって、4月および10月にメジャーリリースを発表しながら、Maharaは6ヶ月ごとのリリースサイクルを保っています。メジャーリリースには重要な新しい機能を含み、バージョンナンバーは0.1ずつ (1.5 -> 1.6 -> 1.7) 増加します。

Maharaのマイナーリリースにはバグフックス (バグ修正) およびセキュリティフィックス (セキュリティ修正) のみ含まれます。マイナーリリースは任意のスケジュールに従って、必要に応じてリリースされます。マイナーリリースのバージョンナンバーは0.01ずつ (1.7.0 -> 1.7.1 -> 1.7.2) 増加します。

サポート存続期間 (Support lifetime)

詳細はSupportedVersionsをご覧ください。

現在、Maharaでは最新の3つのメジャーバージョンに関して更新 (マイナーリリース) を提供しています。このドキュメントの執筆中、これには1.9、1.8および1.7を含みます。古いバージョンのコードベースを利用することはできます。また、オープンソースプロジェクトとして、誰でも変更、バックポートおよび好きなように修正することができますが、Maharaプロジェクトが提供できるサポートは古いバージョンから新しいサポートバージョンへのアップグレードのみです。

最新バージョンのMahara 1.9では1.10またはそれ以上のバージョンからアップグレードすることができます。まだMahara 1.0のインストレーションがある場合、あなたは1.9にアップグレードする前に1.1.0にアップグレードする必要があります。

問題追跡 (Issue tracking)

詳細はDeveloper Area/Bug Statusをご覧ください。

問題点追跡 (Issue tracking) は継続的な品質管理プロセスの重要な一部でもあります。これには問題 (バグ) の報告、改善のアイデアおよび新しい機能を含みます。ほとんどの商用ソフトウェアとは異なり、Maharaの問題報告および追跡情報は誰にでも公開されています。MaharaのバグはLaunchpad.netのMaharaプロジェクトで報告および追跡されています: https://bugs.launchpad.net/mahara

すべてのMaharaユーザは自由に問題追跡システム (issue tracker) の活発な報告者として活動することができます。Launchpadのアカウントを持っている人は誰でもバグ報告を作成、閲覧、コメント、投票および監視することができます。

コードが存在する場所 (Where the code lives)

詳細はDeveloper_Area/Source codeをご覧ください。

ZIPファイルをLaunchpadからダウンロードできるのに対して、完全なMaharaのコードベースはgitバージョン管理システムで管理されています。「生」のコードベースは私たちのhttps://reviews.mahara.orgのGerritコードレビューシステムで保持されています。これは自動的にgit.mahara.org、Github、Gitlab.comおよびthe NZOSSに同期されます。

コードブランチ (Code branches)

1.0_STABLEにさかのぼり、Maharaではそれぞれのメジャーリリースを1.8_STABLE、1.7_STABLEのようにgit「ブランチ」で分けています。加えて、次のメジャーリリースのための開発場所である「マスター (master)」ブランチがあります。

どのようにすれば、あなたのコードがMaharaのコアコードになるのか (How your code becomes Mahara core code)

それでは (あなたのような) コントリビュータ (貢献者) はどのようにすれば、自分のMaharaコードを次のMaharaリリースのために公式gitリポジトリに入れることができるのでしょうか?

コーディングガイドライン (Coding Guidelines)

詳細はDeveloper Area/Coding guidelinesをご覧ください。

最初にコントリビュータがコードを書きます。Maharaには緩いコーディングガイドラインがあり、通常、コードはPHPベストプラクティスに従うことを期待されています: セキュリティプラクティスに従う、周囲のコードと「調和」する、既存のMahara APIを使用する、コードの再利用を最大化する、そしてAPIの変更を最小化するようなことです。

コードの共有 (Sharing the code)

詳細はDeveloper Area/Contributing Codeをご覧ください。

そして、コントリビュータがMaharaプロジェクトとコードを共有します。このための好ましい方法は適切な技術的レベルのあるユーザが直接私たちのGerritコードレビューシステムにコードを送信することです。しかし、私たちはパッチファイル、PHPファイルまたは十分に明確なLaunchpadでのコメントによるコード提供も歓迎します。この場合、Maharaレビュアはコントリビュータに代わってGerrit Changeを作成することができます。

コードレビュー (Code review)

詳細はDeveloper Area/How to Review CodeおよびDeveloper Area/Code Reviewをご覧ください。

Gerritに送信された変更 (通称「パッチ」) は調査および確認 (テスト) されます。それぞれのパッチは誰かがテストして動作を確認したことを意味する「+1」検証スコアを取得する必要があります。また、認定Maharaレビュアがコードを検査して問題が見つからなかったことを意味する「+2」スコアを取得する必要もあります。パッチがテストに合格しない場合、またはレビュー時に問題がある場合、テスト担当者またはレビュアはコントリビュータに対して修正が必要であることを記した分かりやすいコメントを残します。コントリビュータは再度レビューおよびテストを完了した改訂版を提出することができます。

変更が調査および確認された場合、Maharaレビュアは適切なブランチにマージするようgerritOnceで指示することができます。そして、その変更は次のMaharaリリースに適用されます。

セキュリティ問題 (Security issues)

詳細はSecurity#How_to_report_a_security_issue?をご覧ください。

パッチがリリースされるまで一般公開されないことを確実にするため、Maharaのセキュリティ問題には分離された並行のプロセスがあります。

プラグインおよびAPI (Plugins and APIs)

■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■

詳細はDeveloper Area/Pluginsをご覧ください。

Maharaはオープンソースであり、あなたはいつでも希望するときに修正することができますが、Maharaの拡張を維持する最良の方法はプラグインを書くことです。プラグインは単純にすべてのMaharaインストレーションに「入れる (dropped)」ことのできるコードのディレクトリです。プラグインは自動的に検出およびインストールされ、Maharaインターフェース内のツールとして使用できるようになります。

プラグインはMaharaコアの上流に入れる手続きを踏まずに、他のMaharaサイトと簡単に共有することもできます。Mahara wiki上には「サードパーティ」のMaharaプラグインを共有するためのページもあります:　詳細はプラグインをご覧ください。