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
#8 deploy-readme-2985631-8.patch3.73 KBvolkswagenchick
#8 interdiff-2985631-2-8.txt352 bytesvolkswagenchick
#2 deploy-readme-2985631-2.patch3.59 KBvolkswagenchick

Comments

volkswagenchick created an issue. See original summary.

volkswagenchick’s picture

volkswagenchick
she/her
Primary language English
Location San Francisco Bay Area
commented
Assigned: volkswagenchick » Unassigned
Status: Active » Needs review
StatusFileSize
new deploy-readme-2985631-2.patch3.59 KB

I uploaded a patch that adds a readme that aligns to Drupal documentation standards. Thanks!!

dani3lr0se’s picture

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

Patch applies cleanly. Grammar and formatting look good. Links work. Spelling looks good. It now aligns with Drupal standards. Thanks for the patch @volkswagenchick.

manuel garcia’s picture

manuel garcia commented

I think this would be a good idea :)

Drive by review:

+++ b/README.md
@@ -1,7 +1,103 @@
-[![Build Status]
-  (https://travis-ci.org/dickolsson/drupal-deploy.svg?branch=8.x-0.x)
-]
-(https://travis-ci.org/dickolsson/drupal-deploy)

Why remove the travis tag?

volkswagenchick’s picture

volkswagenchick
she/her
Primary language English
Location San Francisco Bay Area
commented

I can re-add the tag if you'd like.

The only reason I removed it is that Travis tags aren't usually included in the READMEs as per documentation guidelines and template.

Let me know if you'd like it re-added.

Cheers,
AmyJune (volkswagenchick)

manuel garcia’s picture

manuel garcia commented

I think we should keep it, its for showing on the github clone where travis is integrated.
Actually the tag current is incorrect (its not displaying properly on github), should be
[![Build Status](https://travis-ci.org/dickolsson/drupal-deploy.svg?branch=8.x-1.x)](https://travis-ci.org/dickolsson/drupal-deploy)

volkswagenchick’s picture

volkswagenchick
she/her
Primary language English
Location San Francisco Bay Area
commented
Assigned: Unassigned » volkswagenchick
Status: Reviewed & tested by the community » Needs work

ok - will do.

volkswagenchick’s picture

volkswagenchick
she/her
Primary language English
Location San Francisco Bay Area
commented
Assigned: volkswagenchick » Unassigned
Status: Needs work » Needs review
StatusFileSize
new interdiff-2985631-2-8.txt352 bytes
new deploy-readme-2985631-8.patch3.73 KB

I uploaded a patch that adds a useful readme and included the Travis build info as mentioned in Comment 6.
I also included an interdiff for easy review.

Thanks for the feedback

manuel garcia’s picture

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

Thanks!

  • jeqq committed 3df2eda on 8.x-1.x authored by volkswagenchick 
    Issue #2985631 by volkswagenchick, Manuel Garcia, daniel_rose: README...
jeqq’s picture

jeqq commented
Status: Reviewed & tested by the community » Fixed

Thanks!

Status: Fixed » Closed (fixed)

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