https://git.drupal.org/project/readmehelp.git 8.x-1.x

Primary tabs

Review of the 8.x-1.x branch (commit 676d69b):
  • Your README.md does not follow best practices (headings need to be uppercase). See https://www.drupal.org/node/2181737 .
    • The INTRODUCTION section is missing.
    • The REQUIREMENTS section is missing.
    • The INSTALLATION section is missing.
    • The CONFIGURATION section is missing.
  • The readmehelp_test.module does not implement hook_help(). See https://www.drupal.org/docs/develop/documenting-your-project/module-docu... .
  • The readmehelp.module does not implement hook_help(). See https://www.drupal.org/docs/develop/documenting-your-project/module-docu... .
  • Coder Sniffer has found some issues with your code (please check the Drupal coding standards). See attachment.
  • DrupalPractice has found some issues with your code, but could be false positives.
    
    FILE: ...01/web/vendor/drupal/pareviewsh/pareview_temp/readmehelp.routing.yml
    --------------------------------------------------------------------------
    FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
    --------------------------------------------------------------------------
     7 | WARNING | The administration page callback should probably use
       |         | "administer site configuration" - which implies the user
       |         | can change something - rather than "access administration
       |         | pages" which is about viewing but not changing
       |         | configurations.
    --------------------------------------------------------------------------
    
    
    FILE: ...pareview_temp/tests/modules/readmehelp_test/readmehelp_test.info.yml
    --------------------------------------------------------------------------
    FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
    --------------------------------------------------------------------------
     7 | WARNING | All dependencies must be prefixed with the project name,
       |         | for example "drupal:"
    --------------------------------------------------------------------------
    
    Time: 1.27 secs; Memory: 8Mb
    
This automated report was generated with PAReview.sh, your friendly project application review script.

FILE: ...000000/site1101/web/vendor/drupal/pareviewsh/pareview_temp/README.md
--------------------------------------------------------------------------
FOUND 0 ERRORS AND 4 WARNINGS AFFECTING 4 LINES
--------------------------------------------------------------------------
   4 | WARNING | Line exceeds 80 characters; contains 98 characters
 198 | WARNING | Line exceeds 80 characters; contains 93 characters
 203 | WARNING | Line exceeds 80 characters; contains 92 characters
 318 | WARNING | Line exceeds 80 characters; contains 123 characters
--------------------------------------------------------------------------


FILE: .../drupal/pareviewsh/pareview_temp/src/ReadmeHelpMarkdownConverter.php
--------------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
--------------------------------------------------------------------------
 215 | WARNING | Only string literals should be passed to t() where
     |         | possible
--------------------------------------------------------------------------


FILE: ...pal/pareviewsh/pareview_temp/tests/modules/readmehelp_test/README.md
--------------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
--------------------------------------------------------------------------
 44 | WARNING | Line exceeds 80 characters; contains 92 characters
--------------------------------------------------------------------------

Time: 2.41 secs; Memory: 10Mb