While evaluating this module, I noticed it lacked a readme.
According to Drupal standards, modules should include a useful README.file.
https://www.drupal.org/docs/develop/documenting-your-project/module-docu....

https://www.drupal.org/docs/develop/documenting-your-project/readme-temp...

Patch to follow, thanks!

CommentFileSizeAuthor
#6 interdiff-3015403-2-6.txt3.05 KBgrimreaper
#6 devel_php-readme-3015403-6.patch2.3 KBgrimreaper
#2 devel_php-README-fix-3015403-2.patch1.94 KBalonaoneill

Comments

alonaoneill created an issue. See original summary.

alonaoneill’s picture

alonaoneill commented
Assigned: alonaoneill » Unassigned
Status: Active » Needs review
StatusFileSize
new devel_php-README-fix-3015403-2.patch1.94 KB

I uploaded a patch that adds README.md fie.
https://www.drupal.org/docs/develop/documenting-your-project/readme-temp...
Thanks for the work on this project!

daggerhart’s picture

daggerhart commented
Status: Needs review » Reviewed & tested by the community

Seems like a reasonable patch to provide a basic readme. Tested on simplytest and patch applies without any problems. Thanks!

grimreaper’s picture

grimreaper
Primary language French
Location France 🇫🇷
commented
Assigned: Unassigned » grimreaper
grimreaper’s picture

grimreaper
Primary language French
Location France 🇫🇷
commented
Status: Reviewed & tested by the community » Needs work 
  1. +++ b/README.md
@@ -0,0 +1,56 @@
+ * For a full description of the module, visit the project page:

    No need of that. 

  2. +++ b/README.md
@@ -0,0 +1,56 @@
+ * To submit bug reports and feature suggestions, or to track changes:

    No need of that. 

  3. +++ b/README.md
@@ -0,0 +1,56 @@
+    1. Navigate to Administration > Extend and enable the module.

    This step is module installation. Not configuration. 

  4. +++ b/README.md
@@ -0,0 +1,56 @@
+       to use it, or add the Execute PHP widget to the Devel Toolbar.

    This sentence needs work because it is not clear. You configure Devel and it has an impact on the output of the execute code form. Also there is a missing step > toolbar Settings tab. 

  5. +++ b/README.md
@@ -0,0 +1,56 @@
+Supporting organizations:

    This project has been sponsored by: 

  6. +++ /dev/null
@@ -1,8 +0,0 @@
-Devel PHP

    Why changing for a .md file?

grimreaper’s picture

grimreaper
Primary language French
Location France 🇫🇷
commented
Status: Needs work » Needs review
StatusFileSize
new devel_php-readme-3015403-6.patch2.3 KB
new interdiff-3015403-2-6.txt3.05 KB

Here is the version I am going to commit.

  • Grimreaper committed a1fd6ad on 8.x-1.x 
    Issue #3015403 by Grimreaper, alonaoneill, daggerhart: README missing
grimreaper’s picture

grimreaper
Primary language French
Location France 🇫🇷
commented
Assigned: grimreaper » Unassigned
Status: Needs review » Fixed

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.