Open
Conversation
✅ Deploy Preview for moodledevdocs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull request overview
Updates tracker label documentation to clarify how QA-related labels should be applied and introduces two new labels to improve communication during QA cycles.
Changes:
- Expanded
mdlqaguidance to clarify when it should be removed and whenqa_identifiedshould be added for historical tracking. - Updated the
qa_identifieddefinition to position it as a long-lived record of QA-found issues. - Added two new QA process labels:
qa_help_neededandqa_instructions_update, including usage/removal guidance.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - `mdlqa` | ||
|
|
||
| Used to flag that an issue is a direct result of a [Moodle QA test](../process/testing/qa.md), conducted just before major releases. The bug should also be linked to the original MDLQA test, so that developers/integrators can reset the original MDLQA test (for re-testing) when the MDL issue is fixed. Once all the related MDLQA tests are passing the label can be deleted. | ||
| Used to flag an issue that was found as a direct result of a [Moodle QA test](../process/testing/qa.md) conducted before a major release. The issue should also be linked to the original MDLQA test, so developers and integrators can reset that test for re-testing once the issue is fixed. Keep this label while the issue is still affecting the QA cycle. Once all related MDLQA tests are passing, remove this label and add qa_identified so we retain a record that the issue was found during the QA cycle. |
| - [`qa_identified`](https://moodle.atlassian.net/issues/?jql=labels%20%3D%20qa_identified) | ||
|
|
||
| Used to flag issues identified in QA testing which we were not able to fix before the release. Hopefully such issues can be worked on shortly after release, removing the label once the issue is fixed. | ||
| Used to flag issues identified during QA testing of past releases. This label provides a permanent record of bugs found during the QA cycle, including both issues that were not fixed before release and issues that were fixed later. Unlike mdlqa, this label should not be removed after the issue is fixed. |
| - [`qa_identified`](https://moodle.atlassian.net/issues/?jql=labels%20%3D%20qa_identified) | ||
|
|
||
| Used to flag issues identified in QA testing which we were not able to fix before the release. Hopefully such issues can be worked on shortly after release, removing the label once the issue is fixed. | ||
| Used to flag issues identified during QA testing of past releases. This label provides a permanent record of bugs found during the QA cycle, including both issues that were not fixed before release and issues that were fixed later. Unlike mdlqa, this label should not be removed after the issue is fixed. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request updates the documentation for QA-related tracker labels to clarify their usage and introduce new labels that improve the QA process. The main changes focus on making the label purposes more explicit and ensuring better tracking and communication during QA cycles.
Label documentation updates:
mdlqalabel, specifying when it should be removed and when to addqa_identifiedfor historical tracking.qa_identifiedlabel to indicate it provides a permanent record of issues found during QA, and clarified that it should not be removed after the issue is fixed.New QA process labels:
qa_help_neededlabel for flagging issues where testers need clarification on test steps, including instructions for use and removal.qa_instructions_updatelabel for flagging issues where test instructions are incorrect or outdated, with guidance on when to add or remove the label.