From feb3152e937ceed721ba3681042878314e8f5caf Mon Sep 17 00:00:00 2001 From: Michael Milette Date: Fri, 26 Apr 2024 11:35:25 -0400 Subject: [PATCH] Updated contributing guidelines and bug reporting form. --- .github/ISSUE_TEMPLATE/bug_report.yml | 4 ++-- CHANGELOG.md | 1 + CONTRIBUTING.md | 6 +++--- 3 files changed, 6 insertions(+), 5 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index b4d8e28..f3bf851 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -65,7 +65,7 @@ body: id: moodle attributes: label: Moodle version - placeholder: e.g. Moodle 4.0.4+ (Build 20220919) + placeholder: e.g. Moodle 4.4.0+ (Build 20240422) validations: required: true - type: checkboxes @@ -104,7 +104,7 @@ body: Client Web Browser: (e.g. Chrome, Edge, Firefox, Safari, Safe Exam Browser, Moodle Mobile App) Server Operating System: (e.g. Windows, Linux, Mac OS, Other - specify) Server Webserver: (e.g. Apache, Nginx, IIS, Other - specify) - Server PHP: (e.g. 7.3, 7.4, 8.x, Other - specify) + Server PHP: (e.g. 7.4, 8.0, 8.1, 8.2, 8.3, Other - specify) - type: checkboxes attributes: label: Code of Conduct diff --git a/CHANGELOG.md b/CHANGELOG.md index aa63e05..a88ac32 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,6 +8,7 @@ All notable changes to this project will be documented in this file. ### Updated - Added a little space between the post-submission message and the Continue button. - Smarter continue button URL logic after the form was submitted. +- Contributing guidelines and bug reporting form. - Copyright notice to 2024. ## [1.3.1] - 2023-10-23 ### Added diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ae6f173..8a73603 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -15,10 +15,10 @@ Keep in mind that the maintainers get final say on whether new features will be Style Guides ------------------- -1. Write in UTF-8 in PHP 5.6, 7.0, 7.1, 7.2, 7.3, 7.4 and 8.0. -2. Follow the official[Moodle Coding Style Guide](https://docs.moodle.org/dev/Coding_style). +1. Write in UTF-8 in PHP 5.6, 7.0, 7.1, 7.2, 7.3, 7.4, 8.0, 8.1 and 8.2. +2. Follow the official[Moodle Coding Style Guide](https://moodledev.io/general/development/policies/codingstyle). 3. Fully test your code with Moodle **Debug Messages** setting set to **DEVELOPER: extra Moodle debug messages for developers** and **Display debug messages** setting checked. Ensure that there are no errors or warnings at all. -4. Test your code using the [Moodle Code Checker](https://moodle.org/plugins/local_codechecker) and [Moodle PHPdoc check](https://moodle.org/plugins/local_moodlecheck) plugins. Ensure that there are no errors or warnings at all. +4. Ensure that your code passes all tests using the [Moodle Code Checker](https://moodle.org/plugins/local_codechecker) and [Moodle PHPdoc check](https://moodle.org/plugins/local_moodlecheck) plugins. Ensure that there are no errors or warnings at all. 5. Look at the existing style and adhere accordingly. Fork the Repository