Problem/Motivation

The README file may not abide by Drupal documentation standards.

Proposed resolution

List changes:

CommentFileSizeAuthor
#3 3113347-3.patch5.55 KBrithesh bk

Comments

Rithesh BK created an issue. See original summary.

rithesh bk’s picture

Assigned: Unassigned » rithesh bk
Status: Needs work » Active

currently working on it .....

rithesh bk’s picture

Assigned: rithesh bk » Unassigned
Status: Active » Needs review
StatusFileSize
new5.55 KB

Please find the updated patch .......

dhirendra.mishra’s picture

Status: Needs review » Reviewed & tested by the community

+1 for RTBC..Good work @rithesh

mradcliffe’s picture

Issue summary: View changes
Status: Reviewed & tested by the community » Needs work
Issue tags: +Needs issue summary update

Hi, @Rithesh BK, @dhirendra.mishra. Thank you for your looking into this and submitting a patch.

I think that most of the standards in the template apply to README.txt files (non-structured text that needs standards) rather than README.md files (structured text in Markdown format). The README template page mentions for new projects to use the template or projects that use Markdown, to use Markdown that is readable by Markdown Filter module ( See "All about Markdown" ).

I think it would be great if you could revert the changes to Markdown formatting and instead focus on any editing or structural needs. One thing to remember is that line breaks make structural changes in Markdown files. Each line. break becomes a new paragraph. If text needs to be grouped into a paragraph, then it should be kept on one line.

I think that I do like having a one line description of the module come before any sub-headings helps introduce the reader.

  • mradcliffe committed 8c03130 on 8.x-1.x
    Issue #3113347 by mradcliffe: Updates README.md
    
mradcliffe’s picture

Status: Needs work » Fixed
Issue tags: -Needs issue summary update

I didn't find much to fix up after further review.

Status: Fixed » Closed (fixed)

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