Development:contrib: Difference between revisions
No edit summary |
|||
| (7 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
CONTRIB is an area in the Moodle CVS repository where developers can work on custom patches and plugins (modules, blocks, themes, etc.) and share them with other people. It is less tightly restricted that the code for Moodle Core in CVS which contains the official Moodle releases. The advantages of using CONTRIB are that it is a standard place where people know to look, so it facilitates sharing your code and allows developers to evaluate and make suggestions. In addition, download packages are automatically build for all plugins in CONTRIB allowing easy access to the latest versions of the contributed code. | |||
You can browse the | ==Browsing CONTRIB== | ||
You can browse the CONTRIB area of CVS here: http://cvs.moodle.org/contrib/ | |||
Most of the interesting code is in the plugins folder. It is organised like the main Moodle codebase, so, for example, if you are looking for an activity module called '''gallery''', look in [http://moodle.cvs.sourceforge.net/moodle/contrib/plugins/mod/gallery/ plugins/mod/gallery]. | Most of the interesting code is in the plugins folder. It is organised like the main Moodle codebase, so, for example, if you are looking for an activity module called '''gallery''', look in [http://moodle.cvs.sourceforge.net/moodle/contrib/plugins/mod/gallery/ plugins/mod/gallery]. | ||
A more user-friendly list of the available plugins is available in the [http://moodle.org/mod/data/view.php?id=6009 Modules and Plugins database] on Moodle.org. | A more user-friendly list of the available plugins is available in the [http://moodle.org/mod/data/view.php?id=6009 Modules and Plugins database] on Moodle.org and documentation for contributed code is maintained via the [https://docs.moodle.org/en/Category:Contributed_code Contributed Code Category]. | ||
==Getting write access to CONTRIB== | |||
If you are a developer working on Moodle patches or plugins, please read [https://docs.moodle.org/en/Development:Guidelines_for_contributed_code Guidelines for Contributed Code] to learn how you can share your code and request write access to CONTRIB. | |||
For more information on how to use CVS once you have write access, read: | |||
* [[Development:CVS_for_developers|CVS for developers]] | |||
==Auto-packaging of CONTRIB plugins and patches== | |||
In the Modules and plugins database, you will see that a lot of the plugins have download URLs like http://download.moodle.org/download.php/plugins/question/type/TEMPLATE.zip. This is because, every night, downloadable copies of every plugin in CONTRIB are automatically built and made available. The download URL is based on the path in the CONTRIB repository. The code for TEMPLATE.zip is in the plugins/question/type/TEMPLATE folder. | |||
==Branches in CONTRIB== | |||
There are branches in CONTRIB CVS for each stable branch in the core Moodle module. The auto-packaging system understands them. This allows for different versions of the patch or plugin, if necessary, to work with different versions of Moodle. | |||
==See also== | |||
* [[Development: | *[[Development:Guidelines for contributed code]] | ||
*Using Moodle [http://moodle.org/mod/forum/discuss.php?d=93365 How to tag(?) different versions in CONTRIB CVS] forum discussion | |||
[[Category:Developer|CVS for developers]] | [[Category:Developer|CVS for developers]] | ||
[[Category:Developer tools]] | [[Category:Developer tools]] | ||
Latest revision as of 16:14, 24 February 2009
CONTRIB is an area in the Moodle CVS repository where developers can work on custom patches and plugins (modules, blocks, themes, etc.) and share them with other people. It is less tightly restricted that the code for Moodle Core in CVS which contains the official Moodle releases. The advantages of using CONTRIB are that it is a standard place where people know to look, so it facilitates sharing your code and allows developers to evaluate and make suggestions. In addition, download packages are automatically build for all plugins in CONTRIB allowing easy access to the latest versions of the contributed code.
Browsing CONTRIB
You can browse the CONTRIB area of CVS here: http://cvs.moodle.org/contrib/
Most of the interesting code is in the plugins folder. It is organised like the main Moodle codebase, so, for example, if you are looking for an activity module called gallery, look in plugins/mod/gallery.
A more user-friendly list of the available plugins is available in the Modules and Plugins database on Moodle.org and documentation for contributed code is maintained via the Contributed Code Category.
Getting write access to CONTRIB
If you are a developer working on Moodle patches or plugins, please read Guidelines for Contributed Code to learn how you can share your code and request write access to CONTRIB.
For more information on how to use CVS once you have write access, read:
Auto-packaging of CONTRIB plugins and patches
In the Modules and plugins database, you will see that a lot of the plugins have download URLs like http://download.moodle.org/download.php/plugins/question/type/TEMPLATE.zip. This is because, every night, downloadable copies of every plugin in CONTRIB are automatically built and made available. The download URL is based on the path in the CONTRIB repository. The code for TEMPLATE.zip is in the plugins/question/type/TEMPLATE folder.
Branches in CONTRIB
There are branches in CONTRIB CVS for each stable branch in the core Moodle module. The auto-packaging system understands them. This allows for different versions of the patch or plugin, if necessary, to work with different versions of Moodle.
See also
- Development:Guidelines for contributed code
- Using Moodle How to tag(?) different versions in CONTRIB CVS forum discussion
