Actions

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

From Mahara Wiki

< Mahara日本語ドキュメント‎ | 開発者エリア

作成中です - mits

このページでは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コードの品質を保証するため、すべてのコントリビューション (寄贈コード) はコード作者ではない信頼できるレビュアによってレビューおよびコミットされます。
  • Mahara セキュリティチームはセキュリティ問題をレビューするMaharaレビュア内のグループです。
    • 信頼できるすべての認証MaharaレビュアはMaharaセキュリティチームへの参加を歓迎します。

Maharaバージョン (Mahara versions)

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

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

Mahara minor releases include only bug fixes and security fixes. They are released as needed, according to no fixed schedule. Minor releases increase the version number by 0.0.1 (1.7.0 -> 1.7.1 -> 1.7.2).

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

See SupportedVersions

Mahara currently provides updates (minor releases) for the three latest major versions. As of this writing, this includes 1.9, 1.8, and 1.7. The code base for older versions is still available, and as an open source project anyone is welcome to make whatever changes or backport whatever fixes they want, but the only support the Mahara project can provide for older versions is to assist in upgrading them to newer, supported versions.

The latest version, Mahara 1.9, provides the ability to upgrade versions 1.1.0 or later. If there are still any Mahara 1.0 installations out there, you'll need to upgrade to 1.1.0 before upgrading to 1.9.

問題点追跡 (Issue tracking)

See Developer Area/Bug Status

Issue tracking is an important part of a continuous quality control process. It involves reporting of problems (bugs), ideas for improvement, and new features. Unlike most proprietary software programs, Mahara issue reporting and tracking information is open to everyone. Mahara bugs are reported and tracked in the Mahara project on Launchpad.net: https://bugs.launchpad.net/mahara

All Mahara users are encouraged to be active participants in the issue tracker. Anyone with a Launchpad account can create, view, comment on, vote, and watch bugs.

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

See Developer_Area/Source code

While ZIP files of Mahara can be downloaded from Launchpad, the full Mahara codebase is managed with the git version control system. The "live" codebase is hosted in a git repo controlled by our Gerrit code review system at https://reviews.mahara.org. This is then synced automatically to Gitorious and Github.

コードブランチ (Code branches)

Mahara has a separate git "branch" for each major release, with the names 1.8_STABLE, 1.7_STABLE, 1.6_STABLE, etc, going all the way back to 1.0_STABLE. Additionally, there is a "master" branch which is the location of ongoing development for the next major release.

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

So how can a contributor (such as yourself) get their Mahara code get into the official git repository as part of the next Mahara release?

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

See Developer Area/Coding guidelines

First, a contributor writes some code. Mahara has a loose set of coding guidelines, and code is generally expected to follow PHP best practices: following security practices, "blending in" with the surrounding code, using Mahara's existing APIs, maximizing code re-use, and minimizing API changes, that sort of thing.

コードの共有 (Sharing the code)

See Developer Area/Contributing Code

Then, the contributor shares their code with the Mahara project. The preferred way to do this, for users with a sufficient level of technical ability, is for them to submit it directly into our Gerrit code review system. But we'll also welcome code contributed via a patch file, a PHP file, or even just a sufficiently specific Launchpad comment. In those cases, a Mahara reviewer can create a Gerrit Change on the contributor's behalf

コードレビュー (Code review)

See Developer Area/How to Review Code and Developer Area/Code Review

The submitted Change (aka "patch") in Gerrit is then reviewed and verified (tested). Each patch must receive a "+1" verified score, which means that someone tested it and found that it worked. It must also receive a "+2" reviewed score, which means that an approved Mahara Reviewer examined the code and saw no problems with it. If the patch fails testing or contains review problems, the tester or reviewer will leave a friendly comment explaining what the contributor needs to change and why. The contributor can then submit a revised version, which will be reviewed and tested anew.

Once the Change has been verified and reviewed, a Mahara Reviewer can then instruct gerrit to merge it into the appropriate branch. It will then be included in the next Mahara release.

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

See Security#How_to_report_a_security_issue?

There's a separate, parallel process for handling Mahara security issues, in order to ensure that they aren't disclosed to the public until after a patch is released.

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

See Developer Area/Plugins

Although Mahara is open source and you can change anything you want, the best and most maintainable way to extend Mahara is to write a plugin. Plugins are a directory of code that can be simply "dropped" in to any Mahara installation and it will be detected, installed, and automatically made available as a tool within the Mahara interface.

Plugins can also easily be shared with other Mahara sites without having to go through the process of being "upstreamed" into Mahara core. There's even a page on the Mahara wiki for sharing "third-party" Mahara plugins: See Plugins