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

akhil_01 created an issue. See original summary.

akhil_01’s picture

Issue summary: View changes
aman_lnwebworks’s picture

Assigned: Unassigned » aman_lnwebworks

aman_lnwebworks’s picture

Assigned: aman_lnwebworks » Unassigned
Status: Active » Needs review

Hi @phjou

I have added README.md template for this module please review it once.

Thank you

kenyoowen’s picture

Status: Needs review » Needs work

Hi

I reviewed your MR!1 and it doesn't follow README.md template. Visit the documentation here.

As per README.md

Drupal recommends the following README sections:

Project name and introduction (required)
Table of contents (optional)
Requirements (required)
Recommended modules (optional)
Installation (required, unless a separate INSTALL.md is provided)
Configuration (required)
Troubleshooting & FAQ (optional)
Maintainers (optional)

Thank you

phjou’s picture

Also the requirements are wrong:

Before you can start, you need to install the drush & media,media_library, file,
migrate, migrate_drupal modules of Drupal Core.

silvi.addweb made their first commit to this issue’s fork.

silvi.addweb’s picture

Status: Needs work » Needs review

Hi, I have updated README.md as per standard templates. Please review.

nisha_j’s picture

Hi,

I have reviewed the README file. The structure generally follows Drupal's recommended format, with clear sections and meaningful links.
RTBC ++
Thankyou.

kenyoowen’s picture

Status: Needs review » Needs work

Hi silvi.addweb

I reviewed the MR!1 and the maintainer section has the wrong format.
It should be

## Maintainers

- Daniel F. Kudwien - [sun](https://www.drupal.org/u/sun)
- Peter Wolanin - [pwolanin](https://www.drupal.org/u/pwolanin)

Thanks

VinmayiSwamy changed the visibility of the branch 1.0.x to hidden.

VinmayiSwamy changed the visibility of the branch 1.0.x to active.

silvi.addweb’s picture

Status: Needs work » Needs review

I have updated README.md as per #11, Please review it.

riddhi.addweb’s picture

Status: Needs review » Reviewed & tested by the community

I have tested the ReadMe.md file format and it seems proper to me, moving this to RTBC.

Readme File:- https://git.drupalcode.org/issue/token_body_image-3416855/-/blob/1.0.x/R...

Reference Doc:- https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or...

  • phjou committed a166c7ea on 1.0.x
    Issue #3416855 by silvi.addweb, kenyoOwen, phjou, riddhi.addweb: README....
phjou’s picture

Merge request was failing for some reasons. I added the file to the branch directly.
Thank you everyone.

phjou’s picture

Status: Reviewed & tested by the community » Fixed

Status: Fixed » Closed (fixed)

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