Skip to content

Update issue guidelines with a prescription to regularly update the issue description

Victor Zagorodny requested to merge vzagorodny-master-patch-85366 into master

Problem to solve

We have a lot of issues across GitLab trackers that are stale or long-running discussions with huge amounts of discussion and content (example 1, example 2). It's hard and consumes too much time to jump into such issues. and quickly grasp the current status and feature changes or important decisions that were made along the way.

Further details

This suggestion was born from observing the UX discovery issues that always have tons of content (several versions of mockups, behaviors, implementors' comments, etc.). The initial proposal is here (internal).

Proposal

The proposal is to prescribe the issue owners to update the issue description with the last information and some kind of brief change history not only when re-assigning to someone else, but constantly and especially in the discussion's turning points. An example of such structured and purposeful description updates can be found here and here.

BTW, other teams are also leveraging the Development log practice while working on their issues. We can be more precise with this handbook update and propose the Development log practice directly.

Merge request reports