CONTRIBUTING.md

CONTRIBUTING

Branches

The master branch contains the latest release. The dev branch contains the development. Features are merged into dev, before dev gets merged into master right before the release happens. A special branch is the demo branch which will modify some code lines in the project to use fake data. The purpose of this is to have an easy way to create screenshots for documentation.

Relase process

• Check if there are any breaking changes that should be handled by a upgrade.php file
• Make sure all changes are documented in CHANGELOG.md
• Change version.php
  • Set $plugin->version
  • Set $plugin->release
  • Check if dependency logstore_lanalytics needs to be changed to a new version
• git commit -m "Version release: vX.X.X"
• git tag vX.X.X
• git push
• git push --tags

Update files on Moodle Plugin store

• Go to the developer zone: https://moodle.org/plugins/local_learning_analytics/devzone
  • Click Add a new version below Releasing a new version
• Click on Release next to the github window (make sure the correct version is listed)
  • Moodle will now download the ZIP
• Make sure Rename root directory in advanced settings
• Select supported Moodle versions
• Click Continue
  • No need to do anything on the next screen
  • Just press Release
• In case there were new language strings introduced:
  • Go back to the devzone: https://moodle.org/plugins/local_learning_analytics/devzone
    • Scroll down to Registration of the plugin strings in AMOS
    • The language strings will be submitted to AMOS
    • Wait until Pending becomes Successful (~2min)
  • Go to the translation page of the plugin: https://lang.moodle.org/local/amos/view.php?t=1641550540&v=l&l=de&c=local_learning_analytics&s&d
    • Click Go to the stage
    • Click Import translated strings from file
    • Select latest tested Moodle version, German as language and upload the language file
    • Click Import
  • Click Send strings to language pack maintainers
    • Enter Updated to latest version as subject
    • Click Submit to maintainers
    • It will take about 1h to 1d until the pack is approved

Changelog

Every changelog should be noted in the CHANGELOG file. The logstore plugin has it's own changelog file.

Versioning

• We'll release version 1 as soon as we want to publish the plugin in the plugin store.
• Major release (1 -> 2): When the plugin structure changes or any major or breaking changes happen.
• Minor release (1.1 -> 1.2): New features.
• Patch release (1.1.0 -> 1.1.1): In case of bugs that are found outside of our normal release plan.

JavaScript Development

• Follow the steps in the Moodle docs.
• Depending on the Node.js version, you are using you might want to comment the lines that check the Node.js version.

When actively developing JavaScript files, use the following command (on Windows) to start the grunt watch. Make sure you are in the plugin directory (moodle/local/learning_anyltics). This will only watch the plugin directory and apply changes on the fly.

grunt watch --root=local/learning_analytics

When the development is done, run the following command to generate the build directory:

grunt amd --root=local/learning_analytics/amd