Mahara開発概要

作成中です - mits

このページではMaharaプロジェクトの開発プロセス全体に関して説明しています。コードに関する技術的詳細はDeveloper_Area/Mahara_Architecture_Introductionをご覧ください。

誰がMaharaを作っていますか?

• Catalyst IT (http://catalyst.net.nz) はMaharaを考案した法人であり、その開発を主導しています。Catalystはhttps://mahara.orgを運用しています。また、フルタイムの (小さな) Mahara開発チーム (「Mahara HQ」と呼ばれます) を保持しています。そして、現在、Maharaリリースサイクルの大部分を担当しています。

• Mahara貢献者 (Contributors) Maharaを改善する人、そしてコミュニティと改善点を共有する人を含みます。一部はMaharaを使用している学校または大学からの貢献者です。そのほかはMaharaインストレーションをサポートするCatalystのような法人です。それから、Maharaに熱心なユーザがいます。貢献の幅は個人によるバグ修正から、システム全体におよぶ機能増強まであります。
  • 一般の方の貢献も歓迎します。
  • LaunchpadにMahara貢献者チームもあります。どなたでもお気軽にご参加ください。
  • 他の貢献者のパッチを「+1 レビュー」済みおよび検証済みであるとマークするため、誰でも「Maharaテスター」グループに参加することもできます。IRCまたはmahara.orgフォーラムでお尋ねください。
• Maharaレビューア 「+2 レビュー」を持つユーザであり、Maharaコードレビューシステム ([1]) にコミットアクセスすることができるユーザです。Maharaコードの質を保証するため、すべての寄贈コードはコード作者ではない信頼できるレビューアによりレビューおよびコミットされます。
  • レビューアになるための手順は次をご覧ください: Developer_Area/Commit_Policy#Becoming_a_reviewer
  • 加えて、gerritグループ、LaunchpadでMaharaプロジェクトの権限を管理するLaunchpad「Maharaグループ」があります: https://launchpad.net/~mahara-reviewers

• Mahara セキュリティチームはMaharaレビューアの一部であり、セキュリティ問題をレビューします。
  • すべての承認Maharaレビューアにおいて、セキュリティに興味のある人、また信頼できる人は自由にaharaセキュリティチームに参加してください。

• Mahara翻訳者はMaharaの翻訳およびユーザマニュアルの翻訳をサポートしている人です。
  • Mahara翻訳者は参加している言語に関して、Launchpadの翻訳グループに招待されます。

Maharaバージョン

6MonthlyCycleをご覧ください。

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

Maharaマイナーリリースにはバグ修正およびセキュリティ修正のみ含みます。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).

サポートライフタイム

See SupportedVersions

Mahara currently provides updates (minor releases) for the three latest major versions. As of this writing, this includes 1.8, 1.7, and 1.6. 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.8, 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.8.

バグ管理 (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/Getting_Code_from_Git

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 a gitorious project, https://gitorious.org/mahara.

コードブランチ (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 プラグイン