Contributing to Mahara: Difference between revisions

Latest revision as of 08:57, 3 October 2016

If you wish to contribute to Mahara, go for it! There are many ways you can help contribute:

Submit bug reports and feature requests

This is an easy one :). If you find a bug in Mahara, and you're sure that it's not a result of any customisations you have made to your Mahara, then make a bug report for it on the tracker. And if you think there's a feature you'd like to see in Mahara, submit a feature request on the same tracker so that we can examine, and hopefully implement, your idea!

Improve the documentation on this wiki

If you find a spelling mistake, a factual error, know something about Mahara that wiki doesn't, or understand another language, there's lots you can do simply by browsing around the wiki and correcting/adding what you can.

Become a helpful member of the forums

How easy is this! All you have to do is subscribe to any forums you like, and answer people's questions and enquiries. There are forums for pedagogy and an open discussion forum, as well as technical forums, so it doesn't matter what kind of background you have. There are even entire groups for specialist subjects like Moodle/Mahara integration.

Translate Mahara into another language

Speaking a language other than English and having a small understanding of Mahara is all you need to be able to translate Mahara into another language. It might pay to ask in the translations forum to check if someone is already translating your language - you may be able to help with the existing effort.

The easiest way to get started translating Mahara is to use the web interface.

Write a new plugin

People with a good understanding of PHP and an idea should be able to write plugins for Mahara. There is not much developer documentation at this time, but we're working on this. You can look around the Mahara source tree and try to gather a picture of how things work, and join #mahara-dev on chat.freenode.net to have realtime chat with the developers.

See the Developer_Area/Plugins for documentation on how to write plugins for Mahara.

Fix bugs in Mahara itself

If you have skills with any of the technologies underlying Mahara - the main ones being PHP, Javascript and SQL - you are well placed to help out by finding and fixing bugs.

Submitting bug reports with patches attached is a great way to earn yourself a beer next time one of us core developers is in your area :). Not to mention the associated fame of being listed as a contributor on Ohloh!

If you have itchy coding fingers and want a bug to fix, check out the tracker - there's a big list of them (including easy "bite sized" bugs) there just waiting for you!

These pages will probably be helpful:

Become a Mahara Partner

You don't have to become a partner to sell services based on Mahara - but if you'd like to be listed on the Partners page and support the project financially, please consider joining the programme.

In addition to the right to use the Mahara trademark commercially (see the partner programme for details), partners receive several benefits such as being featured on mahara.org and gaining access to partner-only support. If your organisation is interested in becoming a partner, please send an email to [email protected].

@@ Line 7: / Line 7: @@
 ==Improve the documentation on this wiki==
-If you find a spelling mistake, a factual error, know something about Mahara that wiki doesn't, or understand another language, there's lots you can do simply by browsing around the wiki and correcting/adding what you can. Especially if you know another language, consider starting a page for it like the existing languages have (see the Spanish and Japanese pages for example). The most important page you can translate - other than this one of course - is the [[System Administrator's Guide/Installing Mahara|installation instructions]].
+If you find a spelling mistake, a factual error, know something about Mahara that wiki doesn't, or understand another language, there's lots you can do simply by browsing around the wiki and correcting/adding what you can.
 ==Become a helpful member of the forums==
@@ Line 13: / Line 13: @@
 How easy is this! All you have to do is subscribe to any forums you like, and answer people's questions and enquiries. There are forums for [http://mahara.org/interaction/forum/view.php?id=25 pedagogy] and an [http://mahara.org/interaction/forum/view.php?id=3 open discussion] forum, as well as [http://mahara.org/interaction/forum/view.php?id=2 technical forums], so it doesn't matter what kind of background you have. There are even entire groups for specialist subjects like [http://mahara.org/group/view.php?id=20 Moodle/Mahara integration].
-==Become a Mahara Partner==
+==Translate Mahara into another language==
-The term "Mahara" and related terms are protected by trademark internationally. See our [[Marketing/Trademark_Policy|Trademark Policy]] for a list of permitted uses.
+Speaking a language other than English and having a small understanding of Mahara is all you need to be able to translate Mahara into another language. It might pay to ask in the [http://mahara.org/interaction/forum/view.php?id=13 translations forum] to check if someone is already translating your language - you may be able to help with the existing effort.
-You don't have to become a partner to sell services based on Mahara - but if you'd like to be listed on the [http://mahara.org/partners Partners] page and support the project financially, please consider joining the programme.
+The easiest way to get started translating Mahara is to use the [https://translations.launchpad.net/mahara-lang web interface].
-In addition to the right to use the Mahara trademark commercially (see the partner programme for details), partners receive several benefits such as being featured on mahara.org and gaining access to partner-only support. If your organisation is interested in becoming a partner, please [http://mahara.org/partner-registration.php fill out the registration form].
+==Write a new plugin==
-==Translate Mahara into another language==
+People with a good understanding of PHP and an idea should be able to write plugins for Mahara. There is not much developer documentation at this time, but we're working on this. You can look around the Mahara source tree and try to gather a picture of how things work, and join #mahara-dev on [http://freenode.net/ chat.freenode.net] to have realtime chat with the developers.
-Speaking a language other than English and having a small understanding of Mahara is all you need to be able to translate Mahara into another language. It might pay to ask in the [http://mahara.org/interaction/forum/view.php?id=13 translations forum] to check if someone is already translating your language - you may be able to help with the existing effort.
+See the [[Developer_Area/Plugins]] for documentation on how to write plugins for Mahara.
-We're in the process of writing documentation to help new translators out, but for now you might want to check out the [http://mahara.org/interaction/forum/view.php?id=13 translations forum] and read [[Developer Area/Language Packs/Structure|this wiki page]].
+==Fix bugs in Mahara itself==
-==Write a new plugin==
-People with a good understanding of PHP and an idea should be able to write plugins for Mahara. There is not much developer documentation at this time, but we're working on this. You can look around the Mahara source tree and try to gather a picture of how things work, and join #mahara on freenode to have realtime chat with the developers.
+If you have skills with any of the technologies underlying Mahara - the main ones being PHP, Javascript and SQL - you are well placed to help out by finding and fixing bugs.
-If you want a plugin but are unable to develop it yourself, consider getting in touch with the developers or a Mahara Partner in your area, who should be able to help you. And if you are able to develop a plugin, you should definitely get in contact with the core developers - we will be able to suggest how your work could be architectured, and developed in such a way that it has the best chance of getting into the Mahara core distribution.
+Submitting bug reports with patches attached is a great way to earn yourself a beer next time one of us core developers is in your area :). Not to mention the associated fame of being listed as a contributor on [http://www.ohloh.net/p/mahara Ohloh]!
-The developers can be contacted through the forums or the #mahara IRC channel on freenode.
+If you have itchy coding fingers and want a bug to fix, [https://bugs.launchpad.net/mahara check out the tracker] - there's a big list of them (including [https://bugs.launchpad.net/mahara/+bugs?field.searchtext=&orderby=-importance&field.status%3Alist=NEW&field.status%3Alist=CONFIRMED&field.status%3Alist=TRIAGED&field.status%3Alist=INPROGRESS&assignee_option=any&field.assignee=&field.bug_reporter=&field.bug_commenter=&field.subscriber=&field.structural_subscriber=&field.tag=bite-sized&field.tags_combinator=ANY&field.has_cve.used=&field.omit_dupes.used=&field.omit_dupes=on&field.affects_me.used=&field.has_patch.used=&field.has_branches.used=&field.has_branches=on&field.has_no_branches.used=&field.has_no_branches=on&field.has_blueprints.used=&field.has_blueprints=on&field.has_no_blueprints.used=&field.has_no_blueprints=on&search=Search easy "bite sized" bugs]) there just waiting for you!
-==Fix bugs in Mahara itself==
+These pages will probably be helpful:
-If you have skills with any of the technologies underlying Mahara - the main ones being PHP, PostgreSQL/MySQL, Apache and Linux - you are well placed to help out by finding and fixing bugs. Submitting bug reports with patches attached is a great way to earn yourself a beer next time one of us core developers is in your area :). Not to mention the associated fame of being listed as a contributor on [http://www.ohloh.net/p/mahara Ohloh]!
+* [[Developer_Area/Developer_Tools]]
+* [[Developer_Area/Developer_Environment]]
+* [[Developer_Area/Contributing_Code]]
+* [[Developer_Area/Coding_guidelines]]
+* [[Developer_Area/How_to_Review_Code]]
-If you have itchy coding fingers and want a bug to fix, [https://bugs.launchpad.net/mahara check out the tracker] - there's a big list of them there just waiting for you! Details on how to get the latest code from git / gitorious are on the [[Download Mahara]] page.
+==Become a Mahara Partner==
-==Make a Case Study View on mahara.org==
+You don't have to become a partner to sell services based on Mahara - but if you'd like to be listed on the [http://mahara.org/partners Partners] page and support the project financially, please consider joining the programme.
-If you've been using Mahara, we'd love to hear about how things are working out for you. A good way to do that is to make a View on mahara.org as a Case Study of your usage of Mahara. There's a template View already created that you can use to get started, and it doesn't have to be too detailed or take you much time. [http://mahara.org/interaction/forum/topic.php?id=467 Read the forum post] for more information.
+In addition to the right to use the [[Marketing/Trademark_Policy|Mahara trademark]] commercially (see the partner programme for details), partners receive several benefits such as being featured on mahara.org and gaining access to partner-only support. If your organisation is interested in becoming a partner, please send an email to partners@mahara.org.