[D8] Module Sitemap

We are currently quite busy with all the project applications and we prefer projects with a review bonus. Please help reviewing and put yourself on the high priority list, then we will take a look at your project right away :-)

Also, you should get your friends, colleagues or other community members involved to review this application. Let them go through the review checklist and post a comment that sets this issue to "needs work" (they found some problems with the project) or "reviewed & tested by the community" (they found no major flaws).

I'm a robot and this is an automated message from Project Applications Scraper.

Hi @bribread22,

Please, correct this issues: http://pareview.sh/pareview/httpgitdrupalorgsandboxbribread222472475git

FILE: ...r/www/drupal-7-pareview/pareview_temp/src/Form/AdminSettingsForm.php
--------------------------------------------------------------------------
FOUND 4 ERRORS AFFECTING 4 LINES
--------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not
| | begin with a file doc comment
40 | ERROR | [x] Whitespace found at end of line
65 | ERROR | [x] Expected 1 blank line after function; 0 found
66 | ERROR | [x] The closing brace for the class must have an empty line
| | before it
--------------------------------------------------------------------------
PHPCBF CAN FIX THE 4 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------

FILE: ...-7-pareview/pareview_temp/src/Controller/ModuleSitemapController.php
--------------------------------------------------------------------------
FOUND 6 ERRORS AFFECTING 5 LINES
--------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not
| | begin with a file doc comment
8 | ERROR | [x] There must be one blank line after the namespace
| | declaration
16 | ERROR | [x] Missing function doc comment
16 | ERROR | [x] Expected 1 blank line before function; 0 found
79 | ERROR | [x] Expected 1 blank line after function; 0 found
80 | ERROR | [x] The closing brace for the class must have an empty line
| | before it
--------------------------------------------------------------------------
PHPCBF CAN FIX THE 6 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------

FILE: /var/www/drupal-7-pareview/pareview_temp/README.txt
----------------------------------------------------------------------
FOUND 0 ERRORS AND 2 WARNINGS AFFECTING 2 LINES
----------------------------------------------------------------------
24 | WARNING | Line exceeds 80 characters; contains 82 characters
28 | WARNING | Line exceeds 80 characters; contains 99 characters
----------------------------------------------------------------------

You can start here:
- Coder: https://www.drupal.org/project/coder
- Installing: https://www.drupal.org/node/1419988
- Command Line Usage https://www.drupal.org/node/1587138

Just a small thing, but you're linking to the Drupal 7 module installation page in your help text. Probably should be https://www.drupal.org/docs/8/extending-drupal-8/installing-modules.

Also, in the troubleshooting section of the help text it's "drush cache-rebuild" in Drupal 8 instead of cc all.

I was able to install the module and view the configuration and permission pages, but I still don't know how to get to the actual module sitemap. Is this something that only happens during the installation of a module via update manager? Or is there a specific page to view? I'd really like to check this out.

@owenpm3: I think you forgot to change the status. Is this now RTBC after your review or are there application blockers left and this should be "needs work"?

Hi bribread22,

Below is my review report for 'module_sitemap' module.

** The git branch 8.x-1.x-dev do not match the release branch pattern, you should remove/rename them
Kindly rename branch to 8.x-1.x instead of 8.x-1.x-dev.

Automated Review

Best practice issues identified by coder.

** I ran phpcs found some issues:

FILE: ...src/Tests/AdminSettingsTest.php
----------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
----------------------------------------------------------------------
 31 | ERROR | Doc comment short description must be on a single line,
    |       | further text should be a separate paragraph
----------------------------------------------------------------------


FILE: ..src/Tests/PermissionsTest.php
----------------------------------------------------------------------
FOUND 3 ERRORS AFFECTING 3 LINES
----------------------------------------------------------------------
 31 | ERROR | Doc comment short description must be on a single line,
    |       | further text should be a separate paragraph
 48 | ERROR | Doc comment short description must be on a single line,
    |       | further text should be a separate paragraph
 69 | ERROR | Doc comment short description must be on a single line,
    |       | further text should be a separate paragraph
----------------------------------------------------------------------

Time: 705ms; Memory: 4Mb

Manual Review

Individual user account

Yes: Follows the guidelines for individual user accounts.

No duplication

Yes: Does not cause module duplication and/or fragmentation.

Master Branch

No: Does not follow the guidelines for master branch.

Licensing

Yes: Follows the licensing requirements.

3rd party assets/code

Yes: Follows the guidelines for 3rd party assets/code.

README.txt/README.md

Yes: Follows the guidelines for in-project documentation and/or the README Template.

Code long/complex enough for review

Yes: Follows the guidelines for project length and complexity. In my opinion, code length seems less, but long enough to review.

Secure code

Yes: Meets the security requirements.

Coding style & Drupal API usage

upon visiting /module-sitemap page, it shows a lit of all modules and all of their routes, Plus this error arises:

Notice: Undefined index: _permission in Drupal\module_sitemap\Controller\ModuleSitemapController->content() (line 50 of modules/custom/module_sitemap/src/Controller/ModuleSitemapController.php).

This review uses the Project Application Review Template.

Hi bribread22,

In ModuleSitemapController.php on line 19, 21,23 you have loaded services statically, you should inject services instead.

STATUS: Reviewed and tested by the community

Automated Review

https://pareview.sh/node/939 Pareview didn't find any problems with your code, so good work you fixed everything

Note that perfect adherence to Drupal Coding Standard is NOT a reason to block an application, except for total disregard of them. However, modules should follow them as closely as possible.

Manual Review

Individual user account

Yes: Follows the guidelines for individual user accounts.

No duplication

Yes: Does not cause module duplication and/or fragmentation.

Master Branch

Yes: Follows the guidelines for master branch.

Licensing

Yes: Follows the licensing requirements.

3rd party assets/code

Yes: Follows the guidelines for 3rd party assets/code.

README.txt/README.md

Yes: Follows the guidelines for in-project documentation and/or the README Template.

Code long/complex enough for review

Yes: Follows the guidelines for project length and complexity.

Secure code

Yes: Meets the security requirements.

Coding style & Drupal API usage

I didn't find any problems, the module works as described. One thing you should consider is adding a link to the config form for the module sitemap page. And please fix the branch in your git clone command.

The starred items (*) are fairly big issues and warrant going back to Needs Work. Items marked with a plus sign (+) are important and should be addressed before a stable project release. The rest of the comments in the code walkthrough are recommendations.

If added, please don't remove the security tag, we keep that for statistics and to show examples of security problems.

This review uses the Project Application Review Template.

Module working fine and all code looks good for me.

Thanks for your contribution, bribread22!

I updated your account so you can promote this to a full project and also create new projects as either a sandbox or a "full" project.

Here are some recommended readings to help with excellent maintainership:

• Dries' post on Responsible maintainers
• Best practices for creating and maintaining projects
• Maintaining a drupal.org project with Git
• Commit messages - providing history and credit
• Release naming conventions.
• Helping maintainers in the issue queues

You can find lots more contributors chatting on IRC in #drupal-contribute. So, come hang out and stay involved!

Thanks, also, for your patience with the review process. Anyone is welcome to participate in the review process. Please consider reviewing other projects that are pending review. I encourage you to learn more about that process and join the group of reviewers.

Thanks to the dedicated reviewer(s) as well.