Projects for new developers: Difference between revisions

Revision as of 16:25, 12 March 2020

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 2: / Line 2: @@
 ==Getting started==
-Moodle uses PHP, JavaScript, SQL 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 the 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].
-''Please consider adopting a [https://moodle.org/plugins/browse.php?list=set&id=61 plugin seeking a new maintainer]''. See the [https://moodle.org/mod/forum/discuss.php?d=260354 Plugins adoption programme].
-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==
@@ Line 20: / Line 14: @@
 ''If you have any ideas for new features in Moodle which might be suitable as projects for new developers, please see [[New feature ideas]].''
-=== Improve SCORM plugin ===
+=== Acceptance tests for the Moodle app ===
-There are a number of areas of SCORM that could be improved as part of a GSOC project, some of these are bigger projects and others could be combined to form a single project.
-These are just some examples, take a look at the open SCORM issues in the Moodle tracker for a list of other issues.
+Since Moodle 3.7 it will be possible to write and run acceptance tests for the Moodle app.
-* Improve Grading (MDL-51086, MDL-52871, MDL-37421)
-* Improve validation of SCORM packages (MDL-38060, MDL-24057)
-* Convert YUI Treeview to use Jquery (Moodle is moving away from YUI and the existing Treeview has a few issues)
-Requirement for prospective students:
-* 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
-:'''Difficulty level''': Medium
-:'''Possible mentor''': [http://moodle.org/user/view.php?id=21591&course=5 Dan Marsden]
-=== Migrate end-to-end testing support in the Mobile app to Ionic 3 ===
-[https://angular.github.io/protractor/#/ Protractor] is an end-to-end test framework for AngularJS applications. Protractor runs tests against your application running in a real browser, interacting with it as a user would.
-There are almost 167 e2e tests in the Mobile app (see detailed information [https://magician03.github.io/2017/08/21/gsoc-moodle-final-phase/ here]).
-The aim of this project is to upgrade the existing end-to-end testing support in the Mobile app to Ionic 3 (the original tests were implemented for Ionic 1/AngularJS).
 Tasks:
-* Upgrade the Node, Protractor and dependencies versions to be able to run tests in modern environments.
+* Write new acceptance tests for the Moodle app
-* Update all the tests so they can run in the new version of the framework (Ionic 3)
-* Update Moodle Mobile documentation with new instructions for setting up both environments.
+Requirement for GSOC prospective students:
-Requirement for prospective students:
+* 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.
+* We also require students to create an additional simple test based [https://github.com/moodlehq/moodle-local_moodlemobileapp on the existing ones]
-* We require prospective students to set-up and run in a local environment the existing tests following this documentation: [[Moodle Mobile End To End Testing]], student must record a video of the tests running on a local machine.
+:'''Skills required:''' Behat (PHP)
-* We also require students to create an additional test (detailed instructions for writing tests are available in the previous link)
-:'''Skills required:''' Javascript (Angular and Ionic 3)
 :'''Difficulty level:''' Medium
 :'''Possible mentor:''' [https://moodle.org/user/profile.php?id=49568 Juan Leyva]
-=== Migrate Moodle Mobile publishing scripts to Gulp tasks ===
+=== Front-end editor for the plugin skeleton generator ===
-Right now the Mobile app uses several scripts ([see here https://github.com/moodlehq/moodlemobile-scripts]) for common tasks related to publishing.
+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.
-Those scripts should be migrated to Gulp tasks so they are available among the other tasks already implemented.
+* 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.
-Tasks:
+:'''Skills required''': PHP + JS
-* Migrate the prepare-release-version.sh script to gulp task
+:'''Difficulty level''': Medium
-* Migrate the prepare-release-integration.sh script to gulp task
+:'''Possible mentor''': [http://moodle.org/user/view.php?id=1601&course=5 David Mudrák]
-* Improve previous scripts to compile the resulting app via Phonegap Build API
-* Migrate the rest of scripts that synchronizes language translations
-Requirement for prospective students:
+=== Make badges criteria a subplugin ===
-* We require prospective students to  set-up a local development environment of the Mobile app (and run it locally) following this documentation: [[Setting_up_your_development_environment_for_Moodle_Mobile_2]], students must provide a video or detailed screenshots including a detailed explanation of what they did to run the app locally.
-:'''Skills required:''' Javascript
+Moodle is an acronym for "Modular Object-Oriented Dynamic Learning Environment" so it allows for extending and tailoring learning environments using community sourced plugins.
-:'''Difficulty level:''' Medium
-:'''Possible mentor:''' [https://moodle.org/user/profile.php?id=49568 Juan Leyva]
-=== Add Mobile app support to Attendance plugin ===
+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).
-A new version of the Moodle Mobile app will be finished in May 2018 - This will provide a simpler way for plugins to add support for the Mobile app.
-Draft spec is available here https://moodle.org/mod/forum/discuss.php?d=361230
-Minimum requirements for this would involve the ability for teachers and students to take attendance, and for students to view their reports.
+* 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
-Requirement for prospective students:
-* 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
 :'''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]
 ==See also==

Documentation