While evaluating this module, while it has a readme, I noticed the readme could use some helpful links and configurations.
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 interdiff-2984209-2-4.txt435 bytesvolkswagenchick
#4 time_range-readme-2984209-4.patch2.3 KBvolkswagenchick
#2 time_range-readme-fix-2984209-2.patch2.3 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 time_range-readme-fix-2984209-2.patch2.3 KB

I have uploaded a patch that adds some useful links and configurations to the existing readme, I also took the time to re-format to better align with Drupal documentations standards.

dani3lr0se’s picture

dani3lr0se commented
Status: Needs review » Needs work

I'd try to pull up line 18 into 17 and create a new line at 80chars. Looks kinda funky this way. Or maybe just create a new line after 17?

Other than that it looks good and the patch applies cleanly. Thanks for the patch @volkswagenchick.

volkswagenchick’s picture

volkswagenchick
she/her
Primary language English
Location San Francisco Bay Area
commented
Status: Needs work » Needs review
StatusFileSize
new time_range-readme-2984209-4.patch2.3 KB
new interdiff-2984209-2-4.txt435 bytes

I made the fix, it does look better. Thanks for the review.

Included an interdiff for easy review

dani3lr0se’s picture

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

Thanks @volkswagenchick. Looks much better with the new line there. Patch still applies. Everything still looks and works fine. Thanks again.

dravenk’s picture

dravenk
He/Him
Primary language English
commented

Thanks
:)

dravenk’s picture

dravenk
He/Him
Primary language English
commented
Status: Reviewed & tested by the community » Fixed
volkswagenchick’s picture

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

Thankyou for all the work you do!!
I am encouraging team mates to help out on Drupal.org with core work, could you go back and give daniel_rose a credit for their RTBC?? They took the time to test and make sure the configs, link, spelling, grammar, etc were correct.
The box next to thier name just gets ticked and they gets a credit! I see it as a way of incentive to help get involved it the community! It takes a village.

Cheers!

AmyJune - volkswagenchick

dravenk’s picture

dravenk
He/Him
Primary language English
commented

dravenk’s picture

dravenk
He/Him
Primary language English
commented

@volkswagenchick This is my mistake, thanks for reminding me.
@daniel_rose Thank you for your help.

Status: Fixed » Closed (fixed)

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