Problem/Motivation
When someone is reviewing an issue in the Needs Review Issue Queue there maybe some recommended steps.
Having an example of a ticket that accomplishes those recommended steps can be very helpful for replicating those steps in the current issue.
For example on:
https://www.drupal.org/project/drupal/issues/3333401#comment-15317531
🐛
Pager h4 causes accessibility flag on many pages
Fixed
@smustgrave mentioned that the schema changes made would require a post update hook for views to handle the update.
I was unfamiliar with how to accomplish that so I asked in slack for an example. @lendude was able to provide some advice as well as an example issue that accomplished a similar goal.
https://www.drupal.org/node/981870 →
I was able to then take that issue and advice to complete the next steps.
It would be beneficial if there were an index of solved issues that reviewers could point to for reference.
Once an issue is solved and marked as fixed it can be hard to find, but having a meta index can be useful in this type of situation.
This index can help with several types of common next steps.
- Coding example of some task that needs to happen (New test, post update hook)
- Change record examples
- Well written reproduction steps
- Api change documentation
Steps to reproduce
N/A
Proposed resolution
Meta project for identifying helpful resolved issues for reference. Generally I would say the documentation section for d.o would be the place, however, I think having a project issue queue for this type of documentation provides several advantages.
- Setting the version that the reference is helpful for is more intuitive.
- We can set custom categories for the issues e.g. test example, issue summary example.
- The issue summary for the meta issue can provide additional instructions to users that have been directed to the meta issue.
- Users can comment if something still is not clear and that feedback can be helpful for other people. (Similar to how the api comments sometimes work)
- I think people are more familiar with searching / updating issues than documentation on d.o
There is also precedent for this type of prompt being a meta issue in a project rather than documentation such as the prompts that the CWG is providing for conflict resolution.
Remaining tasks
Determine best way to document example issues for reviewers and people working on tickets.
Determine criteria for an issue being added as an example of something.
Determine categories for meta project.
User interface changes
N/A
API changes
N/A
Data model changes
N/A
Release notes snippet
N/A