According to Drupal standards, modules should include a useful README.file.
https://www.drupal.org/docs/develop/documenting-your-project/module-docu....
Patch to follow, thanks!

Comments

volkswagenchick created an issue. See original summary.

volkswagenchick’s picture

Assigned: volkswagenchick » Unassigned
Status: Needs work » Needs review
StatusFileSize
new2.22 KB

I have uploaded a patch with an useful README, thanks!

dani3lr0se’s picture

Status: Needs review » Reviewed & tested by the community

Patch looks nice and applies cleanly. Thanks. :)

rahul.nahar001’s picture

Status: Reviewed & tested by the community » Fixed

Thank you for patch file. Patch committed and released module with the updated readme file.

volkswagenchick’s picture

I am encouraging team mates to help out on Drupal.org, could you go back and give Daniel_Rose a credit for his RTBC?? The box next to his name just gets ticked and he 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

dev.patrick’s picture

@volkswagenchick, I understand motive but as per https://www.drupal.org/core/maintainers/issue-credit it is not necessary to issue credit for RTBC with trivial statement unless supported evidence provided.

dani3lr0se’s picture

@dev.patrick, I understand. I know it's a pretty trivial patch and rtbc. I genuinely would like to know what other type of feedback I could've provided for my RTBC? Other than taking the 10 - 15 minutes to read it and then test it on simplytest.me, I don't know what else I could have said. Normally I honestly wouldn't care about getting credit, but I just wanted to share my thoughts to let you know that I genuinely care about helping and enjoyed helping on fix for your nice module. I just think that these types of issues are important to address, trivial or not, documentation and coding standards are important in some ways. They help us for example when we show work to clients. If the client sees typos in the UI or no help text or help documentation it can be confusing for them sometimes. So for us, addressing these types of issues is important in that regard. I get that there are people who are trying to game the system, etc., and I understand not giving credit for trivial comments because of that. You have every right to not issue credit and I totally understand that. I'm just asking for help on my end to maybe make my feedback more meaningful for these types of trivial issues.

Thank you very much for your time and feedback. :)

dev.patrick’s picture

@Daniel_Rose, In my comment at no place I have highlighted that patch is trivial or documentation is something that can be neglected. Mentioned only comment that was added with RTBC. Crux is with RTBC if you would have mentioned details which you himself cleared in last comment that you tested it via simpletest, manually checked readme file. A screenshot would have been also a plus(yes which may vary depending on the bug). Also I wrote I which I inferred with the D.O link.

So I think you already know the feedback you looking for. :)

dani3lr0se’s picture

@dev.patrick, you're right. I didn't mean to imply that you thought it was trivial or not important. I did sort of answer my own question there. It's feedback I normally provide but a lot of maintainers differ with what they prefer. So I just thought I'd ask. That D.O document is a bit ambiguous and not very clear. Ultimately, it's up to the maintainer though. I appreciate your time and feedback very much. :)

Status: Fixed » Closed (fixed)

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