Problem/Motivation

In Drupal core there are lots of testing modules those do not have any description. Its is a good practice to add single line description for each module.

if you are using settings.local.php file and $settings['extension_discovery_scan_tests'] = TRUE; settings is enabled then all testing modules are dispalyed under admin/modules. User interface does not look good with missing description of modules.
Missing description for testing modules.

Steps to reproduce:

1. Inside settings.php enable include of settings.local.php by removing comments around follwoing lines:

if (file_exists($app_root . '/' . $site_path . '/settings.local.php')) {
  include $app_root . '/' . $site_path . '/settings.local.php';
}

2. Make sure $settings['extension_discovery_scan_tests'] is set to TRUE in settings.local.php
3. Now /admin/modules should display all the testing modues as well.

Proposed resolution

Add single description for all testing modules in core.

Remaining tasks

Create Patch.
Review.
Commit.

User interface changes

Display description for all testing modules when $settings['extension_discovery_scan_tests'] settings is enabled.

API changes

N/A

Data model changes

N/A

CommentFileSizeAuthor
#20 reroll_diff_5-20.txt16.39 KBravi.shankar
#20 2950031-20.patch14.15 KBravi.shankar
#5 missing-description-for-testing-modules-2950031-5.patch14.9 KBmsankhala
#2 missing-description-for-testing-modules-2950031-2.patch12.71 KBmsankhala
Missing description for testing modules.png307.77 KBmsankhala

Comments

msankhala created an issue. See original summary.

msankhala’s picture

msankhala commented
StatusFileSize
new missing-description-for-testing-modules-2950031-2.patch12.71 KB
msankhala’s picture

msankhala commented
Issue summary: View changes
msankhala’s picture

msankhala commented
Status: Active » Needs review
msankhala’s picture

msankhala commented
StatusFileSize
new missing-description-for-testing-modules-2950031-5.patch14.9 KB

Missed description of 3 testing modules. Here is updated patch.

borisson_’s picture

borisson_
Primary language Dutch
Location Mechelen, 🇧🇪
commented

This looks like a good idea, but I think we should probably create a coding standards rule to ensure that we don't regress and they are added for all modules?

msankhala’s picture

msankhala commented

@borisson_ creating new coding standard rule is a good idea. We should create a new issue for that. Can this issue be moved to RTBC?

msankhala’s picture

msankhala commented

Created a follow up issue #2969173: Create Coding standard rule to report for missing module/theme description.

borisson_’s picture

borisson_
Primary language Dutch
Location Mechelen, 🇧🇪
commented

Instead of moving this to rtbc, we should probably postpone this on #2969173: Create Coding standard rule to report for missing module/theme description..

msankhala’s picture

msankhala commented
Status: Needs review » Postponed

Postponing this until #2969173: Create Coding standard rule to report for missing module/theme description. get fixed.

Version: 8.6.x-dev » 8.7.x-dev

Drupal 8.6.0-alpha1 will be released the week of July 16, 2018, which means new developments and disruptive changes should now be targeted against the 8.7.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.7.x-dev » 8.8.x-dev

Drupal 8.7.0-alpha1 will be released the week of March 11, 2019, which means new developments and disruptive changes should now be targeted against the 8.8.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.8.x-dev » 8.9.x-dev

Drupal 8.8.0-alpha1 will be released the week of October 14th, 2019, which means new developments and disruptive changes should now be targeted against the 8.9.x-dev branch. (Any changes to 8.9.x will also be committed to 9.0.x in preparation for Drupal 9’s release, but some changes like significant feature additions will be deferred to 9.1.x.). For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

Version: 8.9.x-dev » 9.1.x-dev

Drupal 8.9.0-beta1 was released on March 20, 2020. 8.9.x is the final, long-term support (LTS) minor release of Drupal 8, which means new developments and disruptive changes should now be targeted against the 9.1.x-dev branch. For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

Version: 9.1.x-dev » 9.2.x-dev

Drupal 9.1.0-alpha1 will be released the week of October 19, 2020, which means new developments and disruptive changes should now be targeted for the 9.2.x-dev branch. For more information see the Drupal 9 minor version schedule and the Allowed changes during the Drupal 9 release cycle.

Version: 9.2.x-dev » 9.3.x-dev

Drupal 9.2.0-alpha1 will be released the week of May 3, 2021, which means new developments and disruptive changes should now be targeted for the 9.3.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.3.x-dev » 9.4.x-dev

Drupal 9.3.0-rc1 was released on November 26, 2021, which means new developments and disruptive changes should now be targeted for the 9.4.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.4.x-dev » 9.5.x-dev

Drupal 9.4.0-alpha1 was released on May 6, 2022, which means new developments and disruptive changes should now be targeted for the 9.5.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

spokje’s picture

spokje
Primary language Dutch
commented
Status: Postponed » Needs work

The sniff #2969173: Create Coding standard rule to report for missing module/theme description. landed in Drupal Core with drupal/coder version 8.3.15 in #3262874: Update Coder to 8.3.15.
Unpostponing

ravi.shankar’s picture

ravi.shankar commented
StatusFileSize
new 2950031-20.patch14.15 KB
new reroll_diff_5-20.txt16.39 KB

Added reroll of patch #5 on Drupal 9.5.x.

Version: 9.5.x-dev » 10.1.x-dev

Drupal 9.5.0-beta2 and Drupal 10.0.0-beta2 were released on September 29, 2022, which means new developments and disruptive changes should now be targeted for the 10.1.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 10.1.x-dev » 11.x-dev

Drupal core is moving towards using a “main” branch. As an interim step, a new 11.x branch has been opened, as Drupal.org infrastructure cannot currently fully support a branch named main. New developments and disruptive changes should now be targeted for the 11.x branch, which currently accepts only minor-version allowed changes. For more information, see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 11.x-dev » main

Drupal core is now using the main branch as the primary development branch. New developments and disruptive changes should now be targeted to the main branch.

Read more in the announcement.