User:Michael Große (WMDE)/drafts/Checklist for grooming a maintenance story

These guidelines are intended to support writing a good maintenance/tech issue. Well-written tasks are more likely to be worked on quickly.

Give context

 * Why is this task needed?
 * If possible, link to the context (phab ticket or other) in whose context the technical debt was created or otherwise provide an explanation for the current situation
 * Are there metrics that are related to the issue in this task?
 * If so, link to them (e.g. on Grafana)
 * Or should any metrics be created?
 * Has similar work been done before? ⇾ Link to it
 * Are there currently ongoing discussions on phabricator/wikitech mailing list/on wiki that are related to this ticket? ⇾ Link to it

What needs doing specifically

 * Which other roles need to be consulted/considered?
 * DBAs?
 * Ops people?
 * Other teams affected/needed?
 * Announcements to the community?
 * What components need changing?
 * What components are affected by this?
 * Are there components for which we need to publish a new release to npmjs/packagist/…?

How to get started on this ticket

 * Is there relevant documentation related to this code or problem on wikitech, mediawiki.org, or https://doc.wikimedia.org/ ?
 * How can the problem be reproduced? (Steps to reproduce, actual behavior, current behavior)
 * Are there multiple different ways to mend the underlying problem? If so, mention them all here
 * How to get started with working on this task? Which steps seem necessary to implement it?
 * How to verify that the problem is solved/still exists?
 * Open Questions?

Things that every ticket should have

 * acceptance criteria
 * MediaWiki Preconditions (which extensions need to be installed and enabled, which special settings need to be set in LocalSettings.php)