Note: You are currently viewing documentation for Moodle 3.1. Up-to-date documentation for the latest stable version of Moodle is probably available here: Contributed code.

Category:Contributed code: Difference between revisions

From MoodleDocs
No edit summary
No edit summary
Line 1: Line 1:
An index of documentation pages about contributed code.
An index of documentation pages about contributed code.


Contributed code, or "contrib" for short, is understood to be all code contributed to Moodle which is not included in the standard Moodle distribution.
Contributed code, or "contrib" for short, is understood to be all code contributed to Moodle which is not included in the standard Moodle distribution. The standard Moodle distribution, sometimes known as "Core" code is the code stored and developed at [http://git.moodle.org/gw?p=moodle.git;a=summary git.moodle.org].


The standard Moodle distribution, sometimes known as "Core" code is the code stored and developed at [http://git.moodle.org/gw?p=moodle.git;a=summary git.moodle.org].
Contributed code is usually managed by the developer of the plugin or patch; however, as people change jobs or move on for whatever reason others can volunteer to step in to serve as the primary maintainer of a contribution.  


Contributed code is managed by whoever developed that plug-in. Common options include:
The code is hosted on a the version control system (VCS) of the developers choice. Previously, CVS was used for both [http://cvs.moodle.org/moodle/ core Moodle code] and [http://cvs.moodle.org/contrib/ CONTRIB code]. Git is now the preferred VCS for both Moodle core and CONTRIB code. There are various Git repositories; however, the most commonly used Git repository is [http://github.com/ Github.com].  
* a publicly accessibly git repository containing the code. For example https://github.com/moodlehq/
* the old [http://cvs.moodle.org/contrib/ contrib cvs folder].


All contrib code (and core code) should be indexed in the [http://moodle.org/mod/data/view.php?id=6009 Modules and plugins database].
Developers of CONTRIB code can create their own publicly accessible Git repository of the code (for an example see https://github.com/moodlehq/). Plugins typically use the following naming convention: moodle-{type}_{name} so that the book activity module would be named moodle-mod_book. Developers are encouraged to be consistent.
 
At the moment, all CONTRIB code (and core code) should be indexed in the [http://moodle.org/mod/data/view.php?id=6009 Modules and plugins database]. That said, work is being done to create a new Plugins database that will allow much more flexibility in how CONTRIB code is shared and reviewed. Those interested can follow that work at [http://tracker.moodle.org/browse/MDLSITE-571 MDLSITE-571].
 
Anthony Borrow, the CONTRIB Coordinator, is happy to answer any questions related to CONTRIB code and will help direct folks to the appropriate developer. Feel free to contact the CONTRIB Coordinator via Moodle message.  


==See also==
==See also==

Revision as of 08:17, 14 June 2011

An index of documentation pages about contributed code.

Contributed code, or "contrib" for short, is understood to be all code contributed to Moodle which is not included in the standard Moodle distribution. The standard Moodle distribution, sometimes known as "Core" code is the code stored and developed at git.moodle.org.

Contributed code is usually managed by the developer of the plugin or patch; however, as people change jobs or move on for whatever reason others can volunteer to step in to serve as the primary maintainer of a contribution.

The code is hosted on a the version control system (VCS) of the developers choice. Previously, CVS was used for both core Moodle code and CONTRIB code. Git is now the preferred VCS for both Moodle core and CONTRIB code. There are various Git repositories; however, the most commonly used Git repository is Github.com.

Developers of CONTRIB code can create their own publicly accessible Git repository of the code (for an example see https://github.com/moodlehq/). Plugins typically use the following naming convention: moodle-{type}_{name} so that the book activity module would be named moodle-mod_book. Developers are encouraged to be consistent.

At the moment, all CONTRIB code (and core code) should be indexed in the Modules and plugins database. That said, work is being done to create a new Plugins database that will allow much more flexibility in how CONTRIB code is shared and reviewed. Those interested can follow that work at [https://tracker.moodle.org/browse/MDLSITE-571 MDLSITE-571].

Anthony Borrow, the CONTRIB Coordinator, is happy to answer any questions related to CONTRIB code and will help direct folks to the appropriate developer. Feel free to contact the CONTRIB Coordinator via Moodle message.

See also

Subcategories

This category has only the following subcategory.

Pages in category "Contributed code"

The following 200 pages are in this category, out of 314 total.

(previous page) (next page)

D

(previous page) (next page)