skynettechnologies / moodle-local_allinoneaccessibility Goto Github PK

you still have the wrong license attributed here - Moodle code is gpl v3 so your code must be gpl v3 (or higher) - you can't go back to GPL v2.

https://github.com/skynettechnologies/moodle-local_allinoneaccessibility/blob/main/lib.php#L62

note all user facing strings (including admin) need to be pulled from the lang file.

this is a blocker for plugins db approval.

Moodle uses sentence case - please check your lang strings as some use camel case.

for example strings like:
$string['mystring'] = "My String";
should be:
$string['mystring'] = "My string";

Note: this is not a blocker for approval in the plugins db.

Some of the tests run by the Moodle.org plugins db can be run via github actions on each commit in your github repo. Enabling this helps you to make sure future changes to your plugin will continue to follow the guidelines.

the short version - grab this file:
https://github.com/moodlehq/moodle-plugin-ci/blob/master/gha.dist.yml
rename it as ci.yml and put into the directory .github/workflows within tyour project eg:
https://github.com/danmarsden/moodle-mod_attendance/blob/MOODLE_311_STABLE/.github/workflows/ci.yml

then on every commit you make to github it will fire off a request to run the tests and will give you traffic lights beside each commit and generate a report.

The lang pack files are supposed to be simple strings, it is not a place to store javascript or to have other php executable code.

string concatentaion in the lang packs is also not allowed - it causes problems for the Moodle translation tool

eg:
$string['test'] = "sometext"."somemoretext";
or
$string['test'] = "sometext".$string['someotheritem'];

each line in the file should be a simple string contained within one set of quotes eg:
$string['test'] = "sometext somemoretext";

This is a blocker for plugins db approval.

Your repository name should use the standard frankenstyle Moodle naming convention which makes it easy for moodle admins to identify your plugin.

the correct format to use is moodle-{frankenstylepluginname}
eg if your plugin was "mod_attendance" the correct name to use would be: "moodle-mod_attendance"

Github maintains redirects from your old name to the new one which makes this very easy - just hit the "settings" tab on your github repository and the rename repository option should appear near the top.

in your plugins db entry you need to clearly state that your plugin requires a commercial subscription to use the main features - if there are some features available for free, it should be clear what those features are within the description.

to edit that description, please go to the developer zone tab and hit the "edit this plugin" down the bottom.

note this is a blocker for plugins db approval.

Moodle uses a privacy API for GDPR compliance to allow plugins to specify how they deal with user data. Your plugin integrates with an external service so the privacy api must be implemented prior to approval in the plugins db. In particular you need to look closely at the external link location part that may need to be implemented by your plugin:
https://moodledev.io/docs/apis/subsystems/privacy#indicating-that-you-export-data-to-an-external-location

Sites that use continuous integration processes will not be able to use your plugin because Moodle runs unit tests which check to see if all extra plugins include the privacy class.

More information on the privacy class is here:
https://moodledev.io/docs/apis/subsystems/privacy

Moodle plugins are GPL - (and the php comments in your code include the header) but your readme states the plugin is licensed under MIT:
https://github.com/skynettechnologies/moodle-allinoneaccessibility/blob/main/README.md#license

the .idea folder is an IDE specific folder created by your IDE - it's not part of the actual code and shouldn't really be there - you can add it to your local .gitignore config to help prevent it from being committed in future.

not a blocker for plugins db approval.

The plugins db entry doesn't say much about what this plugin does and "how" it does it - it also doesn't mention any details about the commercial aspects of the plugin - what features are provided for free/ what features need to be paid for - please improve the plugins db entry to make this a lot clearer.

note this is a blocker for plugins db approval.