The README.md currently contains just three lines.

# File replace

This small utility module allows users with the right permissions to replace
files.

Follow the pattern in the README.md template.

CommentFileSizeAuthor
#19 3315879-19.patch2.04 KBamritsingh09
#7 file-replace-readme-3315879-7.patch1.83 KBamritsingh09
#3 Replace_README.patch1.26 KBAnonymous (not verified)
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:

Comments

dineshreddymathuku created an issue. See original summary.

Anonymous’s picture

anujasurve made their first commit to this issue’s fork.

Anonymous’s picture

StatusFileSize
new1.26 KB
dineshreddymathuku’s picture

Status: Active » Needs review

HI #3 patch looks good for me
Thanks

damienmckenna’s picture

Status: Needs review » Needs work

The template is for a plain text file, it doesn't fit the format or structure needed for a Markdown file. This needs more work to fit the Markdown syntax better.

amritsingh09’s picture

Assigned: Unassigned » amritsingh09

I am working on this

amritsingh09’s picture

Assigned: amritsingh09 » Unassigned
Status: Needs work » Needs review
StatusFileSize
new1.83 KB

Hi
I am providing new patch with markdown format and some additions like configuration, maintainer names etc.

avpaderno’s picture

Status: Needs review » Needs work

Keep in mind what the the Drupal coding standards say.

All documentation files should have the file name extension ".txt" to make viewing them on Windows systems easier. Also, the file names for such files should be all-caps (e.g. README.txt instead of readme.txt) while the extension itself is all-lowercase (i.e. txt instead of TXT).

Furthermore, the Drupal coding standards for the Markdown markup are still discussed.

Accepting these changes is up to the maintainers.

-# File replace
+## CONTENTS OF THIS FILE
+------------------------

The last line isn't necessary.

dineshreddymathuku’s picture

Hi @amritsingh09 your patch is looks good for me ill create merge request for this
Thanks

dineshreddymathuku’s picture

Status: Needs work » Needs review
avpaderno’s picture

Status: Needs review » Needs work

Manoj Raj.R made their first commit to this issue’s fork.

Manoj Raj.R’s picture

Status: Needs work » Needs review

Updated according to the changes.
Please Review it!

Manoj Raj.R’s picture

avpaderno’s picture

Title: Replace README.txt with README.md » Expand the content of the README.md file
Issue summary: View changes
ressa’s picture

Issue summary: View changes
Status: Needs review » Needs work

Thanks, please follow the pattern in the README.md template.

amritsingh09’s picture

Assigned: Unassigned » amritsingh09

Ok i will work on this according to the above format.

amritsingh09’s picture

Assigned: amritsingh09 » Unassigned
Status: Needs work » Needs review
StatusFileSize
new2.04 KB

I have added my patch. Please review and advice changes if any.

ressa’s picture

Updating the issue's fork, please review.

nupur badola’s picture

Status: Needs review » Needs work

Reviewed MR!2, the file is not updated as per readme.md file template.

1. ## Introduction should replace by file name.
2. After introduction, table of content should be come.
ressa’s picture

Status: Needs work » Needs review

Thanks for the feedback @Nupur Badola, I have updated the MR.

nupur badola’s picture

Status: Needs review » Needs work

Reviewed MR!5, There is an error.
Two lines prior to ##/### headings

sakthi_dev made their first commit to this issue’s fork.

sakthi_dev’s picture

Status: Needs work » Needs review

Updated the spacing, please review.

bbrala made their first commit to this issue’s fork.

  • bbrala committed 0dfd856b on 8.x-1.x authored by Manoj Raj.R
    Issue #3315879 by amritsingh09, Manoj Raj.R, ressa, dineshreddymathuku,...
bbrala’s picture

Thanks everyone!

bbrala’s picture

Status: Needs review » Fixed

Status: Fixed » Closed (fixed)

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