-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add UPGRADE.md as internal upgrade documentation
- Loading branch information
Showing
2 changed files
with
36 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
Upgrading this plugin | ||
===================== | ||
|
||
This is an internal documentation for plugin developers with some notes what has to be considered when updating this plugin to a new Moodle major version. | ||
|
||
General | ||
------- | ||
|
||
* Generally, this is a quite simple plugin with just one purpose. | ||
* It does not rely on any fluctuating library functions and should remain quite stable between Moodle major versions. | ||
* Thus, the upgrading effort is low. | ||
|
||
|
||
Upstream changes | ||
---------------- | ||
|
||
* This plugin does not inherit or copy anything from upstream sources. | ||
|
||
|
||
Automated tests | ||
--------------- | ||
|
||
* The plugin has a good coverage with Behat tests which test the most important of the plugin's user stories. | ||
|
||
|
||
Manual tests | ||
------------ | ||
|
||
* As the plugin deals with HTML changes in the rich-text-editor, manual tests should be carried out to see if the plugin really keeps working as expected on new Moodle major versions. | ||
|
||
|
||
Visual checks | ||
------------- | ||
|
||
* As the plugin's purpose is to apply particular styles to text in the rich-text-editor, manual tests should be carried out to see if the plugin really looks right on new Moodle major versions. |