Projects for new developers: Difference between revisions

Latest revision as of 14:09, 20 May 2022

Warning: This page is no longer in use. The information contained on the page should NOT be seen as relevant or reliable.

Getting started

Moodle uses PHP, JavaScript, SQL and a number of other Web languages, so learning those is a good place to start.
When you have some basic PHP programming skills, you may wish to start learning about how the Moodle code is organised. It is recommended that you go through the Tutorial.
If you are looking for projects suggested in the tracker, look for issues with the 'addon_candidate' label.
If you are looking to make a quick contribution, look for tracker issues with marked as easy.
As you become more involved in Moodle development, you might like to learn more about the coding conventions used and how changes to Moodle core code are processed. Once you become confident enough, please consider adopting a plugin seeking a new maintainer.

Potential projects

This evolving page lists possible Moodle projects for new developers derived from community suggestions and lists projects together with experienced core developers willing to mentor new developers.

If you have any ideas for new features in Moodle which might be suitable as projects for new developers, please see New feature ideas.

Acceptance tests for the Moodle app

Since Moodle 3.7 it will be possible to write and run acceptance tests for the Moodle app.

Tasks:

Write new acceptance tests for the Moodle app

Requirement for GSOC prospective students:

We require prospective students to set-up and run in a local environment the existing tests hosted here following this documentation: Acceptance testing for the mobile app. Students must record and submit a video of the tests running on a local machine as part of the GSOC application process.
We also require students to create an additional simple test based on the existing ones

Skills required: Behat (PHP)

Difficulty level: Medium

Possible mentor: Juan Leyva

Front-end editor for the plugin skeleton generator

This is a follow-up project for a successful GSOC 2016 project that resulted in a new tool allowing developers to quickly generate a skeleton (scaffolding, template) for a new Moodle plugin. The tool proved to be a helpful helper with significant impact on the quality of Moodle plugins code. This follow-up project aims at further improvements of the skeleton generator. The primary goal is to implement a developer-friendly user interface / front-end editor allowing to configure the plugin's properties (recipe file) easily. The UI should guide the developer through the process of designing and defining the plugin properties and facilitate the whole process.

We require prospective students to make an attempt at fixing at least 1 issue in the Moodle tracker before their proposal can be considered. This MUST be completed before your application can be considered valid.

Skills required: PHP + JS

Difficulty level: Medium

Possible mentor: David Mudrák

Make badges criteria a subplugin

Moodle is an acronym for "Modular Object-Oriented Dynamic Learning Environment" so it allows for extending and tailoring learning environments using community sourced plugins.

Moodle let users create badges, which are a validated indicator of accomplishment, skill, quality or interest that can be earned. However, for now, the criteria for earning them are a closed list (https://docs.moodle.org/en/Using_badges#Criteria).

We require to prepare a mechanism to create custom create to Moodle as a third-party plugin. More information about that can be found here: https://tracker.moodle.org/browse/MDL-39864

Skills required: PHP

Difficulty level: Medium

Possible mentor: Sara Arjona

@@ Line 1: / Line 1: @@
-<!--
+{{Template:WillNotMigrate}}
-[[File:GSoC2012 logo.png|right]]
-<p class="note">'''Latest news:''' ''Moodle will be taking part in the [http://socghop.appspot.com/ Google Summer of Code] for our sixth year in 2012!''</p>
-If you're thinking of applying to work with Moodle for GSOC 2012, please check the information on [[Applying to work with Moodle for GSOC]] and join our gsoc2012@conference.moodle.org jabber chat!
--->
+{{GSOC}}
 ==Getting started==
-Moodle uses PHP, JavaScript and a number of other Web languages, so learning those is a good place to start.
+* Moodle uses PHP, JavaScript, SQL and a number of other Web languages, so learning those is a good place to start.
+* When you have some basic PHP programming skills, you may wish to start learning about how the Moodle code is organised. It is recommended that you go through the [[Tutorial]].
-When you have some basic PHP programming skills, you may wish to start learning about how to Moodle code is organised. It is recommended that you complete the [http://dev.moodle.org/course/view.php?id=2 Introduction to Moodle Programming] course on [http://dev.moodle.org/ dev.moodle.org]. To access this you will need to have an account on moodle.org first.
+* If you are looking for projects suggested in the tracker, look for issues with the [https://tracker.moodle.org/issues/?jql=Difficulty%20%3D%20Easy%20AND%20resolution%20%3D%20Unresolved%20 'addon_candidate' label].
+* If you are looking to make a quick contribution, look for tracker issues with marked as [https://tracker.moodle.org/issues/?jql=Difficulty%20%3D%20Easy easy].
-''If you are looking for projects suggested in the tracker, look for issues with the [https://tracker.moodle.org/issues/?jql=labels%20in%20%28addon_candidate%29 'addon_candidate' label].
+* As you become more involved in Moodle development, you might like to learn more about the [[Coding|coding conventions]] used and how changes to Moodle core code are [[Process|processed]]. Once you become confident enough, please consider adopting a [https://moodle.org/plugins/browse.php?list=set&id=61 plugin seeking a new maintainer].
-''If you are looking to make a quick contribution, look for tracker issues with marked as [https://tracker.moodle.org/issues/?jql=Difficulty%20%3D%20Easy easy].
-As you become more involved in Moodle development, you might like to learn more about the [[Coding|coding conventions]] used and how changes to Moodle core code are [[Process|processed]].
 ==Potential projects==
-This evolving page lists possible Moodle projects for new developers derived from community suggestions.
+This evolving page lists possible Moodle projects for new developers derived from community suggestions and lists projects together with experienced core developers willing to mentor new developers.
 ''If you have any ideas for new features in Moodle which might be suitable as projects for new developers, please see [[New feature ideas]].''
-=== SCORM ===
+=== Acceptance tests for the Moodle app ===
-There are various SCORM related projects I'd be interested in mentoring for GSOC in 2014.
+Since Moodle 3.7 it will be possible to write and run acceptance tests for the Moodle app.
-* Fix/Improve built in SCORM navigation (MDL-25642 MDL-29193 MDL-39551)
-* Improve SCORM performance, PHPDocs, compliance with coding guidelines. - There are a number of known areas of SCORM code that need a clean-up/re-structure - It would be good to audit all the scorm code and make it comply with Moodle's coding guidelines and improve the performance of the code - it would be good to implement MUC in areas that can make use of it - Ideally we would also rewrite the datamodels/scorm_*_.js.php files to separate the php from the js and make the JavaScript cache-able - (work started on this in MDL-35870) Other related bugs: MDL-41216 MDL-41665 MDL-42314
-* SCORM reports - there are currently 3 SCORM reports - ideas on new report plugins would be considered as possible projects.
-:'''Skills required''': PHP, JavaScript
+Tasks:
-:'''Difficulty level''': Medium -> Hard
+* Write new acceptance tests for the Moodle app
-:'''Possible mentor''': [http://moodle.org/user/view.php?id=21591&course=5 Dan Marsden]
-===HTML maths editor===
+Requirement for GSOC prospective students:
-Traditional written mathematical notation takes advantage of a rich set of special symbols, together with their relative size and
+* We require prospective students to set-up and run in a local environment the existing tests hosted [https://github.com/moodlehq/moodle-local_moodlemobileapp here] following this documentation: [[Acceptance testing for the mobile app]]. Students must record and submit a video of the tests running on a local machine as part of the GSOC application process.
-position on a two dimensional page.   Underlying mathematical expressions is a well-defined semantic tree structure.  When typing a mathematical expression into a computer keyboard the ability to take advantage of the features of traditional mathematical notation is severely limited. Essentially one has only a one-dimensional string of symbols taken from the limited alphabet found on computer keyboards and a strict syntax. Syntax is often problematic for users.  For example, they differ between applications and they do not correspond to traditional notation.
+* We also require students to create an additional simple test based [https://github.com/moodlehq/moodle-local_moodlemobileapp on the existing ones]
-DragMath (http://www.dragmath.bham.ac.uk) is a nice "drag and drop" equation editor that has been integrated with the Moodle editor for some time. However, it is implemented in Java, and that is becoming increasingly problematic, with increasing security warnings on the desktop, and limited support on mobile devices. We would like a new editor, keeping all the good parts of DragMath, but written in JavaScript. This could then be integrated with Moodle and other web applications.
+:'''Skills required:''' Behat (PHP)
+:'''Difficulty level:''' Medium
+:'''Possible mentor:''' [https://moodle.org/user/profile.php?id=49568 Juan Leyva]
-Goal: to create a useful and usable "mathematics entry system" for Moodle, using a combination of JavaScript and HTML5.
+=== Front-end editor for the plugin skeleton generator ===
-This should
+This is a follow-up project for a [[GSOC/2016#Plugin skeleton generator|successful GSOC 2016 project]] that resulted in a new tool allowing developers to quickly generate a skeleton (scaffolding, template) for a new Moodle plugin. The tool proved to be a helpful helper with significant impact on the quality of Moodle plugins code. This follow-up project aims at further improvements of the skeleton generator. The primary goal is to implement a developer-friendly user interface / front-end editor allowing to configure the plugin's properties (recipe file) easily. The UI should guide the developer through the process of designing and defining the plugin properties and facilitate the whole process.
-* parse typed expressions into an internal tree representation
-* provide useful feedback to users, e.g. "missing bracket", on ill-formed expressions.
-* have flexible options for providing a "context" to mediate between the requirements of a strict syntax, and users' expectations based on traditional written mathematics.  E.g. is "x(t+1)" a multiplication of x and (t+1) or application of the function "x" to the argument "(t+1)"?
-* have "drag and drop" components (in HTML5)
-* have a modular and flexible output mechanism, this includes
-** on-screen display "as you type/edit"
-** output in a variety of formats, LaTeX, Maxima syntax, MathML etc. which can be embedded into web applications, specifically Moodle.  It is not a goal to provide multiple outputs, but it is a goal to develop a framework in which other users can contribute such formats.
-** show users the internal tree representation on request
-* potentially enable manipulation (computer algebra) of internal expressions by pre-defined rules.
-* have a well documented and simple API.
-Much of the basic design has been done in for example
+* We require prospective students to make an attempt at fixing at least 1 issue in the Moodle tracker before their proposal can be considered. This MUST be completed before your application can be considered valid.
-* DragMath  http://www.dragmath.bham.ac.uk/
-* Numbas    http://www.ncl.ac.uk/maths/numbas/
-* CanvasMath https://code.google.com/p/canvasmath/
-We will draw from this previous design experience to guide the development.
-See this forum thread: https://moodle.org/mod/forum/discuss.php?d=251627 for more.
+:'''Skills required''': PHP + JS
+:'''Difficulty level''': Medium
-:'''Skills required''': JavaScript, HTML 5
+:'''Possible mentor''': [http://moodle.org/user/view.php?id=1601&course=5 David Mudrák]
-:'''Difficulty level''': Hard
-:'''Possible mentors''': Chris Sangwin
-===New question types===
+=== Make badges criteria a subplugin ===
-This is not really a specific project idea, but I would like to point one an important general area:
+Moodle is an acronym for "Modular Object-Oriented Dynamic Learning Environment" so it allows for extending and tailoring learning environments using community sourced plugins.
-With HTML5 the range of what can be done in a web browser keeps expanding. Can we use these possibilities to make new, much more interactive, question types for Moodle?
+Moodle let users create badges, which are a validated indicator of accomplishment, skill, quality or interest that can be earned. However, for now, the criteria for earning them are a closed list (https://docs.moodle.org/en/Using_badges#Criteria).
-There are some ideas in this forum thread: https://moodle.org/mod/forum/discuss.php?d=222439
+* We require to prepare a mechanism to create custom create to Moodle as a third-party plugin. More information about that can be found here: https://tracker.moodle.org/browse/MDL-39864
-* a question type where students have to join things up correctly by adding lines to a diagram (for example to complete an electric circuit).
-* a question type where students can change the colour of certain parts of a diagram, and they have to get it correct.
-* ... I am sure there are more possible ideas. Use your imagination!
-There are also some ideas which don't require complex HTML5 things:
-* A 'Give 3 examples of ...' Question type. For example "Give three ways to speed up a chemical reaction:". Answer 'heat', 'increase concentration', 'catalyst' (in any order). However, 'warm it' might be an acceptable alternative, but 'heat', 'catalyst', 'warm it' should only score 2/3.
-* An ordering question type. Probably based on the OU's qtype_ddwtos. The think that cannot do is give good credit for partially correct answer. For example 'F', 'A', 'B', 'C', 'D', 'E' might be considered close to the right order, but if you do that with ddwtos it will score 0.
-* A question type where students must highlight certain words in some text. E.g. "Find all the verbs in this paragraph."
-There is also scope to make significant enhancements to existing question types. For example
-* in [https://moodle.org/plugins/view.php?plugin=qtype_ddmarker Drag and drop markers] allow teachers to define the drop zones by dragging with the mouse, rather than typing co-ordinates.
-* in [https://moodle.org/plugins/view.php?plugin=qtype_pmatch the pattern-match question type] a tool like STACK question tests to help teachers verify that their answer matching works correctly (upload example responses, indicate what grade they should receive, show what grade they actually receive, and highlight the differences.
-Before proposing anything, please make sure you are familiar with the [https://docs.moodle.org/22/en/Questions standard question types] already available in Moodle, and the [http://moodle.org/plugins/browse.php?list=category&id=29 contributed question types] that other people have already created.
-:'''Skills required''': PHP & JavaScript
-:'''Difficulty level''': Medium - Hard
-:'''Possible mentors''': Tim Hunt
-=== Plagiarism plugin ===
-There are various commercial plugins available that use the Plagiarism API in Moodle, but because these plagiarism systems can require paid subscriptions, testing them can be difficult. I'd like to see a basic plugin developed that could be used for testing the Plagiarism API, providing simple useful functionality. All Plagiarism API functions for all Modules that support the API should be implemented and used. It could check the file contenthash against all other files uploaded in the Moodle files table and if a matching record is found it should display information about the duplicate submission including if the same student has submitted the file in a different course/activity or if a different user has uploaded the file with the same contenthash.
-The first stage of this project is to implement very simple high performing code that allows easy testing of the Plagiarism API and provide some very basic functionality by checking the contenthash
-This code should implement unit tests and behat tests so that we can verify that the Moodle Plagiarism API is functioning correctly.
-The long term plan (possibly after GSOC) would be to get this plugin to post content to an external source which could implement a more complete plagiarism check running on a separate server so it doesn't affect performance of the Moodle site. The Plagiarism plugin "Crot" may have some code that could be repurposed to use for this.
 :'''Skills required''': PHP
 :'''Difficulty level''': Medium
-:'''Possible mentor''': [http://moodle.org/user/view.php?id=21591&course=5 Dan Marsden]
+:'''Possible mentor''': [https://moodle.org/user/profile.php?id=119927&course=5 Sara Arjona]
-:'''Discussion''': [http://dev.moodle.org/mod/forum/discuss.php?d=1822]
 ==See also==
 * [[GSOC]] - describing Moodle's involvement with Google in their Summer of Code program
-* [http://tracker.moodle.org/secure/IssueNavigator!executeAdvanced.jspa?jqlQuery=type+in+%28%22New+Feature%22%2C+Improvement%29+AND+resolution+%3D+unresolved+ORDER+BY+votes+DESC&runQuery=true&clear=true Popular new feature and improvement requests in Tracker]
+* [https://tracker.moodle.org/issues/?jql=type%20in%20%28%22New%20Feature%22%2C%20Improvement%29%20AND%20resolution%20%3D%20unresolved%20and%20labels%20in%20%28addon_candidate%29%20ORDER%20BY%20votes%20DESC Popular new feature and improvement requests in Tracker that can be implemented as plugins]
-[[Category:GSOC]]

Documentation