Note:

If you want to create a new page for developers, you should create it on the Moodle Developer Resource site.

Overview: Difference between revisions

From MoodleDocs
No edit summary
m (Protected "Overview": Developer Docs Migration ([Edit=Allow only administrators] (indefinite)))
 
(50 intermediate revisions by 18 users not shown)
Line 1: Line 1:
A lot of people ask how the development of Moodle operates. This page should give you a working overview that should help in understanding a lot of other developer documentation.
{{Template:Migrated|newDocId=/general/community}}
A lot of people ask how the development of Moodle operates. This page should give you a working overview that should help in understanding a lot of other developer documentation.


(more coming soon)
==The key players==
 
;Martin Dougiamas: Martin is the founder lead developer of Moodle. Generally he tries to facilitate democracy and meritocracy but occasionally has to make executive decisions on things.
 
;[https://moodle.com/careers/ Moodle HQ]: The team of more than 20 developers who are directly funded by the Moodle project to work full-time on core developments.


==The key players==
;Moodle Partners: Over 50 companies around the world that provide Moodle services. These companies often have their own developers and may contribute to Moodle directly by working on core code or by creating plugins.


;Martin Dougiamas: Martin is the lead developer of Moodle. Generally he tries to facilitate democracy and meritocracy but occasionally has to make executive decisions on things.
;Component leads: A number of people around the world have volunteered to lead various components in Moodle. This involves maintaining existing code as well as listening to the community and improving that component with new features.


;Moodle HQ: The mostly-Australian team of developers who are directly funded by the Moodle project to work full-time on core developments. Developers include Martin Dougiamas (moodler), Yu Zhang (lazyfish), Petr Skoda (skodak), Nicolas Connault, Helen Foster (wildgirl) and occasionally Eloy Lafuente (stronk7), Jamie Pratt (jamiesensei).
There are many other people contributing to Moodle in many ways. For a full list see the [http://moodle.org/local/dev/ Moodle developers] page on moodle.org.


;Catalyst: The team of developers working for Moodle clients via Catalyst Ltd in New Zealand, resulting in a lot of core development.  Developers include Martin Langhoff, Penny Leach (mjollnir), Matt Clarkson, and Donal McMullan.
==How we develop the Roadmap==


;Open University: The team of developers working on Moodle implementations at Open University in the UK. Developers include Tim Hunt, Sam Marshall, Nick Freear, Thanh Le and Jenny Gray.
The [[Roadmap]] lists the new features being developed for the next major version. This list is derived mostly from the issues with large numbers of votes in the Moodle [[Tracker]], so please vote for what you want! Other influences include general discussion, surveys and feature requests at Moodle Moots and in the Moodle forums.


There are many other people contributing to Moodle in many ways, these are just the main groups currently working on core development.
Component leads decide on features in individual components so make your case to them!


==Moodle versions==
==Moodle versions==


Moodle major releases occur roughly 6 months or more apart, on no fixed schedule. Each major release increments the version number by 0.1. Minor releases (no new features, just fixes) on each stable branch can occur at any time, whenever enough bug fixes have been made to justify them. The full details can be seen in the [Release notes].
Moodle major releases (with big new features) are on a regular 6 month cycle, in  May and November, since Moodle 2.6. Each major release increments the version number by 0.1 (eg 3.4 -> 3.5 -> 3.6)) and starts a new branch of minor releases.
 
Minor releases (with bug fixes only) are on a 2 month cycle, unless a security emergency occurs. They will increment the major release by 0.0.1 (eg 3.5 -> 3.5.1 -> 3.5.2).  
 
The full details of these can be seen in the [[Releases]].
 
==Support lifetime==


The current development version is always on the trunk of CVS (ie HEAD), while stable branches are split off for every major version (eg MOODLE_18_STABLE).
Moodle HQ is committed to supporting major releases for 12 months of general fixes (usually 6 point releases) and 18 months (an additional 6 months) of security fixes.


That means we usually release minor versions for the last three major branches.


==Release cycles==
Some versions, every two years, are [https://en.wikipedia.org/wiki/Long-term_support long term supported (LTS)] for a total of 36 months, with 18 additional months of security fixes compared to other versions.


Generally a cycle works like this:
==Issue tracking==
;Rapid Development:Long period of several months adding code to the HEAD version of Moodle.  At the same time, all fixes that don't involve database changes or radical core changes are backported to the last two or three stable branches.
;Head Freeze:At some point Martin declares a freeze on new work for a short period to stabilise the core.  All database changes and radical core changes need to have explicit permission from Martin.  This period may be one or two weeks.
;Beta period:Once things get fairly stable, Martin declares a BETA version and this point is marked on HEAD as MOODLE_XX_BETA (eg MOODLE_19_BETA).  Install packages are generated from this for wider testing and feedback via the tracker.  The freeze continues.  This testing period may be anywhere from 2 to 6 weeks.
;Major release:When the core code passes all the testing, the MOODLE_XX_BETA flag is moved up as a branchpoint, and a new stable branch named MOODLE_XX_STABLE is created.  Packages are created, and the release is announced.


Then it all starts again!
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, Moodle issue reporting and tracking information is open to everyone. Moodle's issue tracking system is called the [http://tracker.moodle.org/ Tracker].


==Quality control==
All Moodle users are encouraged to be active participants when it comes to testing. Anyone with a Tracker user account can create, view, comment on, vote, and watch bugs.
 
==Processes==
 
As you might guess, a large software project like Moodle with hundreds of contributors and varied opinions can be difficult to manage.
 
Over time we have developed a number of well-defined processes for getting code in and out of Moodle and for governing everyone's workflow in a way that is fair and clear.
 
See our [[Process]] document for full information on our development processes, including how you can contribute to the project.


==Coding Standards==
==Coding Standards==
===XMLDB===
===XHTML===
===Forms===
===Access===
===Other core libraries===
===Plugins===


==Development processes==
Over time we have distilled our best practice in writing code down into our [[Coding|Coding Guide]].  These rules cover the formatting and layout of all our code to make it consistent across the code base. If you plan to write Moodle code, you need to read it thoroughly.
===Major Development===
 
====Make a proposal====
==Plugins and APIs==
====Create a specification in Moodle Docs====
 
====Seek and absorb community feedback====
Although Moodle is open source and you can change anything you want, the best and most maintainable way to extend Moodle is to write a plugin (sometimes called a module). Plugins are a directory of code that can be simply "dropped" in into any Moodle installation and it will be detected, installed and automatically made available as a tool within the Moodle interface.
====Set up tasks in the Moodle Tracker====
 
====Use CVS and link commits to Tracker====
See our [[Plugins|Plugin documentation]] for full details of the various types of plugin available.
====Comment on milestones in forums and tracker====
 
====Respond to bug reports====
==See also==


===Minor Development===
* [[Finding your way into the Moodle code]]
====Create a new issue in the tracker====
* [[Working with the Community]]
====Attach a patch====
* [[Plugin contribution]]
====Promote the patch====
* [http://www.slideshare.net/poltawski/how-to-guarantee-your-change-is-integrated-to-moodle-core How to guarantee your change is integrated to Moodle core] presentation by Dan Poltawski


==How can you become a Moodle developer?==
[[Category:Quality Assurance|Overview]]
[[Category:Processes|Overview]]

Latest revision as of 07:27, 6 May 2022

Important:

This content of this page has been updated and migrated to the new Moodle Developer Resources. The information contained on the page should no longer be seen up-to-date.

Why not view this page on the new site and help us to migrate more content to the new site!

A lot of people ask how the development of Moodle operates. This page should give you a working overview that should help in understanding a lot of other developer documentation.

The key players

Martin Dougiamas
Martin is the founder lead developer of Moodle. Generally he tries to facilitate democracy and meritocracy but occasionally has to make executive decisions on things.
Moodle HQ
The team of more than 20 developers who are directly funded by the Moodle project to work full-time on core developments.
Moodle Partners
Over 50 companies around the world that provide Moodle services. These companies often have their own developers and may contribute to Moodle directly by working on core code or by creating plugins.
Component leads
A number of people around the world have volunteered to lead various components in Moodle. This involves maintaining existing code as well as listening to the community and improving that component with new features.

There are many other people contributing to Moodle in many ways. For a full list see the Moodle developers page on moodle.org.

How we develop the Roadmap

The Roadmap lists the new features being developed for the next major version. This list is derived mostly from the issues with large numbers of votes in the Moodle Tracker, so please vote for what you want! Other influences include general discussion, surveys and feature requests at Moodle Moots and in the Moodle forums.

Component leads decide on features in individual components so make your case to them!

Moodle versions

Moodle major releases (with big new features) are on a regular 6 month cycle, in May and November, since Moodle 2.6. Each major release increments the version number by 0.1 (eg 3.4 -> 3.5 -> 3.6)) and starts a new branch of minor releases.

Minor releases (with bug fixes only) are on a 2 month cycle, unless a security emergency occurs. They will increment the major release by 0.0.1 (eg 3.5 -> 3.5.1 -> 3.5.2).

The full details of these can be seen in the Releases.

Support lifetime

Moodle HQ is committed to supporting major releases for 12 months of general fixes (usually 6 point releases) and 18 months (an additional 6 months) of security fixes.

That means we usually release minor versions for the last three major branches.

Some versions, every two years, are long term supported (LTS) for a total of 36 months, with 18 additional months of security fixes compared to other versions.

Issue tracking

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, Moodle issue reporting and tracking information is open to everyone. Moodle's issue tracking system is called the Tracker.

All Moodle users are encouraged to be active participants when it comes to testing. Anyone with a Tracker user account can create, view, comment on, vote, and watch bugs.

Processes

As you might guess, a large software project like Moodle with hundreds of contributors and varied opinions can be difficult to manage.

Over time we have developed a number of well-defined processes for getting code in and out of Moodle and for governing everyone's workflow in a way that is fair and clear.

See our Process document for full information on our development processes, including how you can contribute to the project.

Coding Standards

Over time we have distilled our best practice in writing code down into our Coding Guide. These rules cover the formatting and layout of all our code to make it consistent across the code base. If you plan to write Moodle code, you need to read it thoroughly.

Plugins and APIs

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

See our Plugin documentation for full details of the various types of plugin available.

See also