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}}
 {{GSOC}}
+==Getting started==
-==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 [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].
+* 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].
-Moodle uses PHP, JavaScript, SQL and a number of other Web languages, so learning those is a good place to start.
+==Potential projects==
-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.
+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 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].
+''If you have any ideas for new features in Moodle which might be suitable as projects for new developers, please see [[New feature ideas]].''
-''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].
+=== Acceptance tests for the Moodle app ===
-''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].
+Since Moodle 3.7 it will be possible to write and run acceptance tests for the Moodle app.
-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]].
+Tasks:
+* Write new acceptance tests for the Moodle app
-==Potential projects==
+Requirement for GSOC prospective students:
-This evolving page lists possible Moodle projects for new developers derived from community suggestions.
+* 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]
-''If you have any ideas for new features in Moodle which might be suitable as projects for new developers, please see [[New feature ideas]].''
+:'''Skills required:''' Behat (PHP)
+:'''Difficulty level:''' Medium
+:'''Possible mentor:''' [https://moodle.org/user/profile.php?id=49568 Juan Leyva]
-=== Plagiarism plugin (Moorsp) ===
+=== Front-end editor for the plugin skeleton generator ===
-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 (called Moorsp) that could be used for testing the Plagiarism API and provides a structure that can be built on in future to add further functionality.
+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.
-The initial aim of this project is not to develop a new Plagiarism checking tool but to develop a tool that provides complete Behat and unit tests for the Moodle Plagiarism API.
+* 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.
-All files uploaded to Moodle are stored on disk using the contenthash of the file as the filename - this means that if a user uploads the exact file multiple times in different locations only one file is stored on disk. The plugin should implement a check to see if the exact file has been submitted to any other courses/activities and display related information if another match has been found.
+:'''Skills required''': PHP + JS
+:'''Difficulty level''': Medium
+:'''Possible mentor''': [http://moodle.org/user/view.php?id=1601&course=5 David Mudrák]
-Existing Plagiarism plugins (turnitin, urkund, compilatio etc) make use of the legacy log feature of the events api - the new plugin should use the new api and not rely on legacy logs.
+=== Make badges criteria a subplugin ===
-Deliverables:
+Moodle is an acronym for "Modular Object-Oriented Dynamic Learning Environment" so it allows for extending and tailoring learning environments using community sourced plugins.
-* All Plagiarism API functions should be implemented.
-* Support for Assign, forum and Workshop modules should be implemented.
-* Full Unit test coverage of all plugin functions.
-* Full Behat tests for Assign, forum and workshop modules should be implemented to ensure that all Plagiarism API functions are working as expected.
-* The code should pass 100% of the Moodle codechecking tools to ensure the code meets with Moodle Guidelines.
-* The code should perform well with appropriate use of the Moodle caching tools.
-Future Improvements (outside scope of initial project)
+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).
-* Add Plagiarism API to the Moodle Glossary plugin.
-* Implement functions that allow the plugin to post content to an external source - a future open source moorsp server that will receive content and generate a similarity report - we may be able to re-purpose some of the code from the old plagiarism_crot plugin to do this.
-This project was proposed in previous GSOC years and some useful information is available in the older discussion [http://dev.moodle.org/mod/forum/discuss.php?d=1822 here]
+* 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''': [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]
-:'''Message from the mentor''': [http://dev.moodle.org/mod/forum/discuss.php?d=2280 Tips for applying to the moorsp project]
-:'''Initial code structure''': [https://github.com/danmarsden/moodle-plagiarism_moorsp]
-=== Allow to crop/resize/rotate images when inserting them ===
-This project is inspired by MDL-32183. There are two options on how to implement this functionality - as a repository plugin or as an atto plugin.
-:'''Skills required''': Javascript (YUI), PHP
-:'''Difficulty level''': Medium
-:'''Possible mentor''':
 ==See also==
@@ Line 63: / Line 58: @@
 * [[GSOC]] - describing Moodle's involvement with Google in their Summer of Code program
 * [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]
-* [[Projects for new developers/Archive|Archive]] of outdated and/or inactive calls for projects
-* [https://docs.moodle.org/dev/Moodle_Wishlist a Wishlist] by some Moodle users. Some of the good ideas here may be adopted.

Documentation