Maintainer response templates for common contribution scenarios

This page contains suggested text that you can use (possibly with modifications) when giving feedback in the core issue queue. These comment templates are used by core committers, but may be useful to maintainers and reviewers as well, including those in contributed projects (with appropriate modifications).

No interdiff

Thanks for your help updating this patch. In the future, when using a patch workflow, provide <a href="https://www.drupal.org/documentation/git/interdiff">interdiffs</a> for your patches. That allows reviewers to evaluate your changes. 

No credit for common unhelpful contributions

The following comment templates can be used when responding to contributions that are not credited under the Drupal core issue credit guidelines.

Unhelpful review or RTBC comment

Thank you for reviewing this issue!

The automated testing infrastructure tells us whether the change set still applies, so we do not need people to review that. It is also not sufficient criteria for the issue to be marked "Reviewed and Tested by the Community".

What we do need people to review is whether the issue has a correct <a href="https://www.drupal.org/core/scope">scope</a>, whether it passes the <a href="https://www.drupal.org/core/gates">core gates</a>, whether the solution completely fixes the problem without introducing other problems, and whether it's the best solution we can come up with. See the <a href="https://www.drupal.org/patch/review">patch review guide</a> for more information.

When you do post a review, be sure to describe what you reviewed and how. This helps other reviewers understand why you considered the issue RTBC (and is considered for issue credit).

Also see the <a href="https://www.drupal.org/core/maintainers/issue-credit">issue credit guidelines</a> for more information on which kinds of contributions are credited.

Unhelpful attachments

Thank you for looking into this issue.

Posting screenshots of your codebase or command-line interface does not advance the issue, since the automated testing infrastructure tells us whether the change set still applies correctly.

So, I have not granted issue credit for that screenshot. In the future, you can get credit for issues by reading the issue to understand its purpose, and posting your review or testing of that purpose. Thank you!

See the <a href="https://www.drupal.org/core/maintainers/issue-credit">issue credit guidelines</a> for more information.

Reroll, merge, rebase, or conversion to MR with no merge conflict or other changes

Thank you for your assistance on this issue.

Simple rerolls, rebases, merges, or conversions to merge requests no longer receive issue credit. Only updates that address a merge conflict or that include other fixes will be credited. For merge conflicts, the merge conflict that was resolved must be documented in the text of an issue comment.

To receive credit for contributing to this issue, assist with other outstanding tasks or unaddressed feedback.

See the <a href="https://www.drupal.org/core/maintainers/issue-credit">issue credit guidelines</a> for more information.

Patch posted when issue work has been converted to an MR

Thank you for your interest in working on this issue.

This patch has been converted to a merge request (MR), so posting additional patches (especially with the same failures) is not helpful. I am removing credit for the additional patch after the merge request was opened, and have hidden the file attachments.

In the future, you can get credit for issues by reading the issue to understand its purpose, and taking into account all the discussion on the issue. <a href="​https://www.drupal.org/core/maintainers/issue-credit">More information on the issue credit guidelines</a>.

Thank you!

Unhelpful/disruptive reroll

Thank you for looking into this issue.

The reroll in comment # is not valid and does not take into account the current discussion. 

So, I've removed the issue credit for that reroll. In the future, you can get credit for issues by reading the issue to understand its purpose, and taking into account all the discussion on the issue. <a href="​https://www.drupal.org/core/maintainers/issue-credit">More information on the issue credit guidelines</a>.

If you're encountering difficulty resolving a conflict with a patch or merge request, you can help more by explaining in your comment what the conflict is and how you've tried to resolve it. 

Thank you!

Unnecessary merge in MR

Thank you for looking into this issue.

The push in comment # is unnecessary as the merge request could still be applied to HEAD.

So, I've removed the issue credit for that push. In the future, you can get credit for updates to issues that are required. <a href="​https://www.drupal.org/core/maintainers/issue-credit">More information on the issue credit guidelines</a>.

Thank you!

Common reasons to mark an issue back to "Needs work" or "Needs review"

The following responses are for common reasons that an issue in the "Reviewed & tested by the community" status might be marked "Needs work". They can also be used for issues marked "Needs review".

Convert patch to merge request when updating

While you are making the above changes, we recommend that you convert this patch to a <a href="https://www.drupal.org/docs/develop/git/using-gitlab-to-contribute-to-drupal/creating-merge-requests">merge request</a>. Merge requests are preferred over patches. Be sure to hide the old patch files as well. (Converting an issue to a merge request without other improvements is not recommended and will not receive credit.)

Multiple merge requests and/or patches

The issue summary includes both patches and a merge request/multiple merge requests. There should be only one canonical patch or merge request listed.

Please close any non-canonical merge request(s) and hide non-canonical patches. If you don't have permission to close merge requests, please hide any non-canonical patches and then document which merge request(s) should be closed in an issue comment and under a separate header in the issue summary. This will allow a committer to close them for you. Thanks!

Needs tests

Bug report

Thanks for filing this bug report and for fixing the issue. Bug fixing is very valuable. In order to commit a bug fix, we need an automated test to prove that we've fixed the bug and ensure that we don't break it again in the future. For more information about writing tests in Drupal, see the following links:

<ol>

<li>https://www.drupal.org/docs/testing/phpunit-in-drupal/phpunit-javascript-test-writing-tutorial</li>

<li>https://api.drupal.org/api/drupal/core%21core.api.php/group/testing</li>

</ol>

Feature request

Thanks for filing this feature request. In order to commit a feature request, we need an automated test to prove that it works and ensure that we don't break it in the future. For more information about writing tests in Drupal, see the following links:

<ol>

<li>https://www.drupal.org/docs/testing/phpunit-in-drupal/phpunit-javascript-test-writing-tutorial</li>

<li>https://api.drupal.org/api/drupal/core%21core.api.php/group/testing/li>

</ol>

Needs usability review (Tag issue "Needs usability review" and, if appropriate, "Needs screenshots")

Thanks for your work on this issue.

We should get usability feedback about [describe what specifically needs UX feedback].

Make sure to <a href="https://www.drupal.org/community/contributor-guide/task/add-screenshots-to-a-drupal-issue">add up-to-date screenshots of the new or changed user interface elements</a> to assist the usability review as this is required by the <a href="https://www.drupal.org/about/core/policies/core-change-policies/drupal-core-gates#usability">core usability gate</a>.

Once your changes are ready for review, you can get usability feedback from the <code>#ux</code> channel in <a href="https://www.drupal.org/slack">Drupal community Slack</a>. There are weekly usability meetings that start from that channel on Fridays at 10:00 am Eastern Time (15:00 or 14:00 UTC depending on the time of year).

If the usability team suggests additional changes, those changes should be implemented before the usability team can sign off the issue and remove the "Needs usability review" tag. Thanks!

Spelling error patches without a cspell dictionary update

Thank you for your work on fixing spelling errors in Drupal.

We can make sure this spelling error never happens again by <a href="https://www.drupal.org/node/3122084#dictionary">removing the entry from Drupal's dictionary</a>, so let's update the issue to include that. Thanks!

Unused variables

Thank you for your work on cleaning up Drupal core's code. We should handle each unused variable on its own merit and do research to work out why it is not used. 

Unused variables can point to broken code or incomplete testing. See [#3157369] for an example. 

A useful tool for this is <code>git log -S "SOME TEXT"</code> which will search git commits for matching text to find out when the variable might have become unused. <code>git blame</code> can be useful as well.

We need to do the research to show why the variable is unused before the issue is committed. Thanks!

Incorrect issue scope

The following responses can be used for common issue scoping mistakes.

Coding standards

Thank you for your work on cleaning up Drupal core's code style!

In order to fix core coding standards in a maintainable way, all our coding standards issues should be done on a per-rule basis across all of core, rather than fixing standards in individual modules or files. We should also separate fixes where we need to write new documentation from fixes where we need to correct existing standards. This all should be done as part of [#2571965]. A good place to start is the child issues of [#2572645].

For background information on why we usually will not commit coding standards fixes that aren't scoped in that way, see the <a href="https://www.drupal.org/core/scope">core issue scope guidelines</a>, especially the <a href="https://www.drupal.org/core/scope#coding-standards">note about coding standards cleanups</a>. That document also includes numerous <a href="https://www.drupal.org/core/scope#examples">suggestions for scoping issues</a> including documentation coding standards cleanups.

Contributing to the overall plan above will help ensure that your fixes for core's coding standards remain in core in the long term. 

Removing deprecated usages

Thank you for your work on cleaning up Drupal core's use of deprecated APIs!

In order to deprecate APIs in a maintainable way, converting deprecated uses should be replaced across all of core for a given kind of usage, rather than in individual modules or files. Such issues should also always be part of an overall plan to ensure all usages are removed, rather than standalone issues.

For background information on why we usually will not commit cleanups that aren't scoped in that way, see the <a href="https://www.drupal.org/core/scope">core issue scope guidelines</a>. See the <a href="https://www.drupal.org/core/deprecation">core deprecation policy</a> for more information on how we handle deprecations.

Contributing to the overall plan above will help ensure that your cleanups for core's deprecated code improve core in a maintainable and minimally disruptive way. 

Incorrect target branch

The following responses can be used when issues are filed against an incorrect branch.

Issue filed against the major branch incorrectly

Under our <a href="https://www.drupal.org/core/deprecation">continuous upgrade path and deprecation policy</a>, feature and API additions should be added with backwards compatibility in minor releases, so I am moving this issue to 11.x. It should be backported to Drupal 11 and include only changes that are allowed in minor releases. Thanks!

Issue incorrectly targeting a maintenance minor for for disruptive changes

Maintenance minors should only include four kinds of changes: 

<ol>
<li>Security and upgrade path fixes.</li>
<li>Non-disruptive bug fixes that are backported to patch releases.</li>
<li>Dependency updates and PHP compatibility fixes.</li>
<li>Important API additions for deprecations that unblock contrib compatibility across Drupal 10 and 11.</li>
</ol>

This issue does not meet those criteria, so it should target a feature minor of Drupal 11. Thanks!

Marking an issue "won't fix"

Feature request

Thanks for proposing this feature. We rely on issue submissions like this one to improve Drupal core. 

I discussed this issue with... (subsystem maintainer, product manager, etc.)

In this particular case, I/we don't believe the feature is a good fit for Drupal core, for the following reasons: 

<ul>
<li>We try to limit how many options are exposed in the user interface for usability and accessibility reasons.</li>
<li>This proposed feature is not a foundational capability for the 80% usecase of Drupal core and also is not part of the strategic product roadmap.</li>
<li>It should be possible to implement the functionality in contributed or custom code.</li>
<li>[any other reasons]</li>
</ul>

If you're interested in contributing and maintaining this feature for the ecosystem, I suggest creating a contributed project / proposing it as a feature request for the _____ project. 

Given the above, I am marking the issue "Closed (won't fix)" for Drupal core. Thanks again!