Problem/Motivation

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....

Proposed resolution

Follow the pattern in the README.md template.

CommentFileSizeAuthor
#7 coding-standards-in-readme-2981573-7.patch1.89 KBurvashi_vora
#2 csv_importer-readme-2981573-2.patch1.95 KBvolkswagenchick

Issue fork csv_importer-2981573

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

About issue forks

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 csv_importer-readme-2981573-2.patch1.95 KB

I uploaded a patch that aligns the readme with Drupal Documentation standards, thanks!

alonaoneill’s picture

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

Patch applied using simplytest.me. Reviewed the patch for spelling and grammar. Formatting aligns to Drupal documentation standards. https://www.drupal.org/docs/develop/documenting-your-project/module-docu...
https://www.drupal.org/docs/develop/documenting-your-project/readme-temp...
Marking RTBC. Thanks for your work on a module.

dqd’s picture

dqd
Location London | N.Y.C | Paris | Hamburg | Berlin
commented
Status: Reviewed & tested by the community » Needs work

I think IF this issue still persist, it needs work, since the project will have changed over the last 3 years. Otherwise anyone feel free to close this issue if the observations of the opener have been rendered outdated.

urvashi_vora’s picture

urvashi_vora commented
Assigned: Unassigned » urvashi_vora

I will check this.

urvashi_vora’s picture

urvashi_vora commented

I took the latest git code pull and found that the issue still persists.

FILE: ...ml/contribution/d8_cont/web/modules/contrib/csv_importer-2981573/README.md
--------------------------------------------------------------------------------
FOUND 0 ERRORS AND 5 WARNINGS AFFECTING 5 LINES
--------------------------------------------------------------------------------
 10 | WARNING | Line exceeds 80 characters; contains 90 characters
 11 | WARNING | Line exceeds 80 characters; contains 110 characters
 25 | WARNING | Line exceeds 80 characters; contains 123 characters
 26 | WARNING | Line exceeds 80 characters; contains 101 characters
 31 | WARNING | Line exceeds 80 characters; contains 141 characters
--------------------------------------------------------------------------------

Resolving issues with README.md file.

urvashi_vora’s picture

urvashi_vora commented
Assigned: urvashi_vora » Unassigned
Status: Needs work » Needs review
StatusFileSize
new coding-standards-in-readme-2981573-7.patch1.89 KB

Hi,

Please review this.

Thanks

ressa’s picture

ressa
he/him
commented
Assigned: Unassigned » ressa
Status: Needs review » Needs work

I'll update the formatting.

ressa opened merge request !6

ressa’s picture

ressa
he/him
commented
Assigned: ressa » Unassigned
Issue summary: View changes
Status: Needs work » Needs review

I have updated the format to Markdown, added a TOC, as well as other small adjustments. You can preview the Merge Request here: https://git.drupalcode.org/issue/csv_importer-2981573/-/tree/2981573-rea...

Sonal Gyanani made their first commit to this issue’s fork.

lashabp’s picture

lashabp commented
Status: Needs review » Fixed

Status: Fixed » Closed (fixed)

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