Contributing to Mahara: Difference between revisions
From Mahara Wiki
No edit summary |
No edit summary |
||
| (10 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
If you wish to contribute to Mahara, go for it! There are many ways you can help contribute: | If you wish to contribute to Mahara, go for it! There are many ways you can help contribute: | ||
==Submit bug reports and feature requests== | ==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 [http://mahara.org/tracker/ make a bug report for it on the tracker]. And if you think there's a feature you'd like to see in Mahara, | 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 [http://mahara.org/tracker/ 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== | ==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. | 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== | ==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 [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]. | 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]. | ||
==Translate Mahara into another language== | ==Translate Mahara into another language== | ||
| Line 44: | Line 17: | ||
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. | 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. | ||
The easiest way to get started translating Mahara is to use the [https://translations.launchpad.net/mahara-lang web interface]. | |||
==Write a new plugin== | ==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. | 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. | ||
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 [http://www.ohloh.net/p/mahara Ohloh]! | |||
If you have | 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! | ||
These pages will probably be helpful: | |||
* [[Developer_Area/Developer_Tools]] | |||
* [[Developer_Area/Developer_Environment]] | |||
* [[Developer_Area/Contributing_Code]] | |||
* [[Developer_Area/Coding_guidelines]] | |||
* [[Developer_Area/How_to_Review_Code]] | |||
== | ==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 [http://mahara.org/partners Partners] page and support the project financially, please consider joining the programme. | |||
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 [email protected]. | |||
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:
- Developer_Area/Developer_Tools
- Developer_Area/Developer_Environment
- Developer_Area/Contributing_Code
- Developer_Area/Coding_guidelines
- Developer_Area/How_to_Review_Code
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].