Coding - Revision history

Devdocsbot: Protected "Coding": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

2022-05-31T13:20:53Z

Protected "Coding": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

← Older revision	Revision as of 13:20, 31 May 2022
(No difference)

2022-05-31T13:18:57Z

Update migration status and path

← Older revision		Revision as of 13:18, 31 May 2022
Line 1:		Line 1:
			{{Template:Migrated\|newDocId=/general/development/policies}}
	This page is the top-level page describing Moodle's coding guidelines. It's the place to start if you want to know how to write code for Moodle.		This page is the top-level page describing Moodle's coding guidelines. It's the place to start if you want to know how to write code for Moodle.

2022-01-31T04:05:26Z

Reverted edits by Andrewnicols (talk) to last revision by Mitsuhiro Yoshida

← Older revision		Revision as of 04:05, 31 January 2022
Line 119:		Line 119:

	Please note that Moodle coding style and design is pretty unique, it is not compatible with [http://pear.php.net/manual/en/standards.php PEAR coding standards] or any other common PHP standards.		Please note that Moodle coding style and design is pretty unique, it is not compatible with [http://pear.php.net/manual/en/standards.php PEAR coding standards] or any other common PHP standards.

			[[ja:開発:コーディング]]

2022-01-31T04:04:36Z

Reverted edits by Mits (talk) to last revision by Andrew Nicols

← Older revision		Revision as of 04:04, 31 January 2022
Line 119:		Line 119:

	Please note that Moodle coding style and design is pretty unique, it is not compatible with [http://pear.php.net/manual/en/standards.php PEAR coding standards] or any other common PHP standards.		Please note that Moodle coding style and design is pretty unique, it is not compatible with [http://pear.php.net/manual/en/standards.php PEAR coding standards] or any other common PHP standards.

	~~[[ja:開発:コーディング]]~~

2022-01-29T15:03:53Z

← Older revision		Revision as of 15:03, 29 January 2022
Line 119:		Line 119:

	Please note that Moodle coding style and design is pretty unique, it is not compatible with [http://pear.php.net/manual/en/standards.php PEAR coding standards] or any other common PHP standards.		Please note that Moodle coding style and design is pretty unique, it is not compatible with [http://pear.php.net/manual/en/standards.php PEAR coding standards] or any other common PHP standards.

			[[ja:開発:コーディング]]

2021-04-14T02:48:48Z

Update JS guidelines with modern standards

← Older revision		Revision as of 02:48, 14 April 2021
Line 40:		Line 40:
	==JavaScript==		==JavaScript==

	~~In general, everything~~ in Moodle should ~~work with JavaScript turned off~~ in ~~your browser~~. ~~This~~ is ~~important for accessibility,~~ and ~~in line~~ with the ~~principles~~ of ~~unobtrusive JavaScript and progressive enhancement~~.		New Javscript in Moodle should be written as Vanilla javascript in the ES6 style. The use of jQuery, YUI, and other frameworks is strongly discouraged and will not be accepted into core except when dealing with legacy interfaces which require the use of those objects.

	~~Features that~~ are ~~not available without JavaScript must be compliant with all accessibility standards~~.		In general code should be written to avoid displaying interfaces which are removed, or adding new interfaces as the page loads.

	~~See the [[JavaScript guidelines\|Moodle JavaScript guidelines]] for more information~~.		All Javascript must be accessible.

	==Internationalisation==		==Internationalisation==

2020-04-06T11:10:49Z

Events

← Older revision		Revision as of 11:10, 6 April 2020
Line 85:		Line 85:

	See:		See:
	* [[Events API]] - Since Moodle 2.6		* [[Events API]] - Since Moodle 2.6 - in particular, note the [[Events_API#Events_naming_convention\|Events naming convention]].
	* [[~~Old~~ Events_API]] ~~- Moodle 2~~.~~0 - 2~~.5
			==Web services==

			Should be implemented according to [[Web service API functions]] and [[How to contribute a web service function to core]], including the [[Web_service_API_functions#Naming_convention\|Naming convention]].

	==Manual testing==		==Manual testing==

2020-04-06T10:46:28Z

Point to renamed Event API pages

← Older revision		Revision as of 10:46, 6 April 2020
Line 85:		Line 85:

	See:		See:
	* [[~~Events_API\|~~Events API]] - Moodle 2.~~0 - 2.5~~		* [[Events API]] - Since Moodle 2.6
	* [[~~Event_2\|New Events API~~]] - Moodle 2.~~6 and later~~		* [[Old Events_API]] - Moodle 2.0 - 2.5

	==Manual testing==		==Manual testing==

2018-08-01T01:23:43Z

Add link to manual testing instruction guidelines.

← Older revision		Revision as of 01:23, 1 August 2018
Line 87:		Line 87:
	* [[Events_API\|Events API]] - Moodle 2.0 - 2.5		* [[Events_API\|Events API]] - Moodle 2.0 - 2.5
	* [[Event_2\|New Events API]] - Moodle 2.6 and later		* [[Event_2\|New Events API]] - Moodle 2.6 and later

			==Manual testing==

			All issues integrated into the core codebase are tested both during Integration, and subsequently by our testing team. While much of this testing is automated, there are many parts which cannot be automated, and manual testing is required.

			Moodle has guidelines on [[Testing_instructions_guide\|how to write clear testing instructions]] which we recommend you read and follow.

	==Unit testing==		==Unit testing==

2018-06-13T17:05:35Z

← Older revision		Revision as of 17:05, 13 June 2018
Line 16:		Line 16:
	==Coding style==		==Coding style==

	Consistent coding style is important in any development project, and particularly so when many developers are involved. A standard style helps to ensure that the code is easier to read and understand, which helps overall quality.		Consistent [[Coding style\|coding style]] is important in any development project, and particularly so when many developers are involved. A standard style helps to ensure that the code is easier to read and understand, which helps overall quality.

	Writing your code in this way is an important step to having your code accepted by the Moodle community.		Writing your code in this way is an important step to having your code accepted by the Moodle community.