Problem/Motivation

Follow the pattern in the README.md template

Proposed resolution

Remaining tasks

User interface changes

API changes

Data model changes

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

Mohd Sahzad created an issue. See original summary.

chetan 11 made their first commit to this issue’s fork.

chetan 11’s picture

Status: Active » Needs review

Please check the above for Readme.md file.

kenyoowen’s picture

Component: Code » Documentation
Status: Needs review » Needs work

Hi

I reviewed your MR!2 but it doesn't follow the README.md template.

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.

rajas samse’s picture

Status: Needs work » Needs review
StatusFileSize
new2.96 KB

Resolved issue, please review.

Raveen Thakur made their first commit to this issue’s fork.

Raveen Thakur changed the visibility of the branch 1.0.x to hidden.

d-xpert’s picture

Priority: Normal » Minor
Status: Needs review » Needs work

Changing the status back to Need work as the changes are not as per the Drupal readme.md template.

chancenyasulu’s picture

Hey Xpert it will good to include packthub link https://api.packt.com/api-docs#section/Overview for those who wants to get API token for packthub

in README.

rajas samse’s picture

Status: Needs work » Needs review
StatusFileSize
new2.91 KB

Made all the necessary changes. Please review.

kenyoowen’s picture

Status: Needs review » Needs work

Hi Raveen Thakur

I reviewed your changes in MR!2 and introduction and project name should be on 1 section and installation section should be

Install as you would normally install a contributed Drupal module. For further
information, see
[Installing Drupal Modules](https://www.drupal.org/docs/extending-drupal/installing-drupal-modules).

For more information please read the documentation.

Thank you.

raveen_thakur51’s picture

Status: Needs work » Needs review
d-xpert’s picture

Status: Needs review » Reviewed & tested by the community

Rest of it looks fine. Moving to RTBC.

d-xpert’s picture

Fixed the MR conflicts .

chancenyasulu’s picture

Status: Reviewed & tested by the community » Fixed

Readme doc added.

chancenyasulu’s picture

Status: Fixed » Closed (fixed)