While evaluating this module, while it has a readme, - I noticed the readme could use some helpful links and configurations. Also, the formatting does not align to Drupal standards for documentation. There should be a clear table of contents and lines should be hard wrapped at 80 characters for better accessibility.
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
#4 default_toolbar_menu-README-3063735-4.patch2.19 KBalonaoneill
#2 default_toolbar_menu-README-3063735-2.patch2.18 KBalonaoneill

Comments

alonaoneill created an issue. See original summary.

alonaoneill’s picture

alonaoneill commented
Assigned: alonaoneill » Unassigned
Status: Active » Needs review
StatusFileSize
new default_toolbar_menu-README-3063735-2.patch2.18 KB
jqtnguyen’s picture

jqtnguyen commented

Please consider the following feedback, which includes changes to conform with Drupal.org documentation standards at https://www.drupal.org/docs/develop/documenting-your-project/readme-temp...

+++ b/README.md
@@ -1,14 +1,55 @@
+    4. Add user with some role, logout and login with the new user with some role.

Text should manually word-wrap within around 80 cols.


+++ b/README.md
@@ -1,14 +1,55 @@
+ * Add some role, Add some toolbar menu, and make sure the role has the permisson

Text should manually word-wrap within around 80 cols. Also, "permisson" is a typo and should be "permission".

alonaoneill’s picture

alonaoneill commented
StatusFileSize
new default_toolbar_menu-README-3063735-4.patch2.19 KB

Made changes!
Please review!
Thanks!

Willtg’s picture

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

Reviewed the patch for spelling and grammar. Formatting aligns to Drupal documentation standards. Everything looks good. Patch applied with STM.
Marking as RTBC.
Thank you for working on module!

  • 6e844f6 committed on 1.x 
    Issue #3063735 by yang_yi_cn: fix README format.
yang_yi_cn’s picture

yang_yi_cn commented
Status: Reviewed & tested by the community » Fixed
yang_yi_cn’s picture

yang_yi_cn commented
Version: 8.x-1.x-dev » 2.0.0
Status: Fixed » Closed (fixed)