Problem/Motivation

README.md is not available.

Steps to reproduce

Download the module and go to in to the module directory, You will get README.txt.

Proposed resolution

Convert README.txt to README.md

CommentFileSizeAuthor
#4 Browser_readme.PNG25.94 KBkavitha89

Issue fork bu-3362640

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

Nishant created an issue. See original summary.

nishant’s picture

Assigned: nishant » Unassigned
Status: Active » Needs review

Hi @Daniel Moberly,

Please Review and Merge.

kavitha89’s picture

Status: Needs review » Reviewed & tested by the community
StatusFileSize
new25.94 KB

The patch works fine and moving it to RTBC.

avpaderno’s picture

Status: Reviewed & tested by the community » Needs work
Issue tags: -README.txt

It is not sufficient to rename a file. The file content needs to follow the README.md template, until the Drupal coding standards do not prescribe a different template.

gajanan.wasnik made their first commit to this issue’s fork.

gajanan.wasnik’s picture

Assigned: Unassigned » gajanan.wasnik
Status: Needs work » Needs review
avpaderno’s picture

Assigned: gajanan.wasnik » Unassigned
Status: Needs review » Needs work

The merge request is just renaming a file. See my previous comment.

gajanan.wasnik’s picture

Status: Needs work » Needs review

Please review merge request 4

kenyoowen’s picture

Status: Needs review » Needs work

Hi

I reviewed your MR!4 and the configuration section is not helpful. As per README.md template "If the module has little or no configuration, you should use this space to explain how enabling/disabling the module will affect the site."

Thank you

gajanan.wasnik’s picture

Assigned: Unassigned » gajanan.wasnik
Status: Needs work » Needs review
kenyoowen’s picture

Assigned: gajanan.wasnik » Unassigned
Status: Needs review » Reviewed & tested by the community

Hi gajanan.wasnik

I reviewed your MR!4 and confirmed that it follows the README.md template.

Thank you

avpaderno’s picture

Status: Reviewed & tested by the community » Needs work

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

viren18febs’s picture

Status: Needs work » Needs review
nupur badola’s picture

Status: Needs review » Needs work

Reviewed MR!4, the patch is not cleanly applied:

1. Text manually word-wrapped within around 80 cols.
2. Project page and issue queue is missing from Introduction section.
3. Table of content format is incorrect

and there are many more issues, Please refer https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or-distribution-project/documenting-your-project/readmemd-template for readme.md file template

apaderno changed the visibility of the branch 3362640-UpdateReadme to hidden.

avpaderno’s picture

Status: Needs work » Needs review
nupur badola’s picture

Status: Needs review » Reviewed & tested by the community

Reviewed MR!4, the file is updated as per the readme.md file template.
Hence marking it to RTBC.

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

pebosi’s picture

Version: 2.1.1 » 2.1.3
Status: Reviewed & tested by the community » Fixed

Now that this issue is closed, review the contribution record.

As a contributor, attribute any organization that helped you, or if you volunteered your own time.

Maintainers, credit people who helped resolve this issue.

Status: Fixed » Closed (fixed)

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