We could be using README.md instead of README.txt to make use of the nicer rendering via markdown.

CommentFileSizeAuthor
#6 3321173-6.patch2.38 KBsrishtipandey

Issue fork inlinejs-3321173

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:

About issue forks

Comments

pragya.diwan created an issue. See original summary.

pragya.diwan opened merge request !1

pragya.shroti’s picture

pragya.shroti commented
Assigned: pragya.shroti » Unassigned
Status: Active » Needs review

Updated the README.txt file to README.md

Pracheth’s picture

Pracheth commented
Status: Needs review » Needs work

The README.txt file is incomplete (https://git.drupalcode.org/issue/inlinejs-3321173/-/blob/2.0.x/README.md). Request the maintainers of the module to add more info regarding the module as per Drupal README standards.

Follow this pattern for README file-
https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or...

changing the status to needs work.

srishtipandey’s picture

srishtipandey commented
Assigned: Unassigned » srishtipandey
srishtipandey’s picture

srishtipandey commented
StatusFileSize
new 3321173-6.patch2.38 KB

I have replaced README.txt with README.md file.Uploading a patch for it,please review.

srishtipandey’s picture

srishtipandey commented
Assigned: srishtipandey » Unassigned
srishtipandey’s picture

srishtipandey commented
Status: Needs work » Needs review
ressa’s picture

ressa
he/him
commented
Status: Needs review » Needs work

Thanks everyone, but please use the Issue fork system for patches.

Also, the patch does not follow the recommended syntax for Markdown in the README.md template guidelines. For example:

  • Headings capitalized with an initial capital, and not underlined
  • Bulleted lists denoted by dashes (-)

Also, code examples should be encapsulated with ` (inline) or ``` (section).

Sonal Gyanani’s picture

Sonal Gyanani commented
Assigned: Unassigned » Sonal Gyanani

Sonal Gyanani opened merge request !2

Sonal Gyanani’s picture

Sonal Gyanani commented
Assigned: Sonal Gyanani » Unassigned
Status: Needs work » Needs review

Created merge request for the issue.
Please review
Thanks

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

Manoj Raj.R’s picture

Manoj Raj.R commented

Updated with Readme format.

Please review.

Manoj Raj.R’s picture

Manoj Raj.R commented
Charchil Khandelwal’s picture

Charchil Khandelwal commented
Status: Needs review » Reviewed & tested by the community

MR !2 looks good to me.
So moving to RTBC.