Merge branch 'develop' into bug/ID18

.github/workflows/moodle-ci.yml

@@ -102,3 +102,29 @@ jobs:
  - name: Behat features
  if: ${{ always() }}
  run: moodle-plugin-ci behat --profile chrome
+
+ - name: Convert Coverage (clover2lcov)
+ uses: andstor/clover2lcov-action@v1
+ if: ${{ always() }}
+ with:
+ src: ./coverage.xml
+ dst: ./coverage/lcov.info
+
+ - name: Coveralls Parallel
+ if: ${{ always() }}
+ uses: coverallsapp/github-action@master
+ with:
+ github-token: ${{ secrets.github_token }}
+ flag-name: run-${{ matrix.test_number }}
+ parallel: true
+
+ finish:
+ needs: test
+ if: always()
+ runs-on: ubuntu-latest
+ steps:
+ - name: Coveralls Finished
+ uses: coverallsapp/github-action@master
+ with:
+ github-token: ${{ secrets.github_token }}
+ parallel-finished: true

.gitignore

@@ -3,3 +3,5 @@
 *.code-workspace
 
 .idea/
+
+.history

CHANGELOG.md

@@ -6,12 +6,35 @@ and this project adheres to [Semantic Versioning](https://semver.org).
 
 ## [Unreleased]
 
-## [0.1.0] - YYYY-MM-DD
+
+## [0.1.4] - 2022-06-06
 ### Fixed
+- Fix Moodle colpliance violations.
+
+## [0.1.3] - 2022-01-15
 ### Added
+- Add help button for question ID field on manual issue registration page. #40
+
+### Fixed
+- Fix edit mechanism of issue name. #39
+
+## [0.1.2] - 2021-12-15
 ### Changed
+- Updated docs for only using one block for multiple activity modules.
 
+## [0.1.1] - 2021-08-02
+### Fixed
+- Fix missing context when course modules are deleted. #33
 
-[Unreleased]: https://github.com/KQMATH/moodle-mod_capquiz/compare/v0.1.0...HEAD
+## [0.1.0] - 2021-07-22
+### Added
+- Ability to register manual issues.
+- Modular external API for creating QTracker blocks.
+- Backup and Restore API.
+- Privacy API is implemented in order to comply with the [General Data Protection Regulation](https://en.wikipedia.org/wiki/General_Data_Protection_Regulation) (GDPR).
 
-[0.1.1]: https://github.com/KQMATH/moodle-mod_capquiz/compare/v0.1.0...v0.1.1
+[Unreleased]: https://github.com/KQMATH/moodle-local_qtracker/compare/v0.1.4...HEAD
+[0.1.4]: https://github.com/KQMATH/moodle-local_qtracker/compare/v0.1.3...v0.1.4
+[0.1.3]: https://github.com/KQMATH/moodle-local_qtracker/compare/v0.1.2...v0.1.3
+[0.1.2]: https://github.com/KQMATH/moodle-local_qtracker/compare/v0.1.1...v0.1.2
+[0.1.1]: https://github.com/KQMATH/moodle-local_qtracker/compare/v0.1.0...v0.1.1

README.md

@@ -1,35 +1,29 @@
 # moodle-local_qtracker
-:bug: Local Moodle plugin providing issue tracking for Moodle questions.
-
-The QTracker system allows students to comment and ask questions about individual questions in a quiz. The idea and design follows the principles of issue tracker systems, although it is still work in progress and some features will be missed still.
-
-In addition to the QTracker module, a separate block-type module is needed to add the interface to a given activity type. Such block modules have been made for
-+ [Core Quiz](https://github.com/KQMATH/moodle-block_quizqtracker)
-+ [CAPQuiz](https://github.com/KQMATH/moodle-block_capquizqtracker)
+[![build](https://github.com/KQMATH/moodle-local_qtracker/actions/workflows/moodle-ci.yml/badge.svg?branch=master)](https://github.com/KQMATH/moodle-local_qtracker/actions/workflows/moodle-ci.yml)
 
-The QTracker functionality is normally accessed via the appropriate block plugin.
-
-## Add the tracker to an Activity
-
-1. Open the activity as teacher.
-2. Turn editing on.
-3. Click «Add Block» in the left hand menu.
-4. Choose the appropriate block - single-click - this is slow to react.
+:bug: Local Moodle plugin providing issue tracking for Moodle questions.
 
-The block should now appear both in the student and teacher interface, with different contents, but it must be tested. Sometimes it is necessary to tweak the settings, found in the gear menu in the block itself.
+The QTracker system allows students to comment and ask questions about individual questions in a quiz. The idea and design follows the principles of issue tracker systems.
 
-## As student
+In addition to the QTracker module, an accompanying block module is needed to add the interface to a supported activity type. This block is available [here](https://github.com/KQMATH/moodle-block_qtracker).
 
-The student interface is straight forward. Enter a title and a text, and hit submit.
+The block currently supports the following activity modules:
+* [Moodle Quiz](https://docs.moodle.org/en/Quiz_activity)
+* [CAPQuiz](https://github.com/KQMATH/moodle-mod_capquiz)
 
-## Managing issues
+## Documentation
+Documentation is available [here](https://github.com/KQMATH/moodle-local_qtracker/wiki), including [installation instructions](https://github.com/KQMATH/moodle-local_qtracker/wiki/Installation-instructions).
 
-In the teacher interface to the activity, the block shows a link to manage issues. 
+## Feedback:
+**Project lead:** Hans Georg Schaathun <[email protected]>
 
-**TODO** list features.
+**Developer:** [André Storhaug](https://github.com/andstor) <[email protected]>
 
-## Note on publishing as LTI
+## License
+QTracker is licensed under the [GNU General Public, License Version 3](https://github.com/KQMATH/moodle-local_qtracker/LICENSE).
 
-Observe that LTI does not support blocks in the student view. This module does not work when students access the acitivity over LTI.
+## Related
 
-For our own use, we have patched the core moodle installation to show block in LTI, and we are contemplating more permanent solutions.
+- [CAPQuiz](https://moodle.org/plugins/mod_capquiz) - Computer adaptive practice activity module for Moodle
+- [ShortMath](https://moodle.org/plugins/qtype_shortmath) - Moodle question type for writing mathematical expressions using MathQuill
+- [JazzQuiz](https://moodle.org/plugins/mod_jazzquiz) - Moodle activity module, letting the teacher run a preplanned quiz with the power of improvisation