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

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

Raghavendra A M created an issue. See original summary.

raghavendra a m’s picture

Status: Active » Needs review

Committed according to the proposed solution.

Please review it.

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

Pracheth’s picture

Status: Needs review » Reviewed & tested by the community

Reviewed the README.md (latest MR! by Raghavendra A M #2), which needed some minor work on markdown formatting and added maintainers section along with their URLs.

Committed the changes to the issue fork, Now the Markdown looks good to me(https://git.drupalcode.org/issue/session_limit-3322435/-/blob/3322435-re...), Adhering to Drupal markdown practices.

Changing status to Reviewed and Tested by Community.

Manoj Raj.R’s picture

Status: Reviewed & tested by the community » Needs work

After reviewing it needs some changes as per markdown format

Manoj Raj.R’s picture

Status: Needs work » Needs review

Made some major updates which are respect to the markdown format.

Other than everything looks good to me.

Please review it

Can be moved to RTBC.

nupur badola’s picture

Errors in the patch exists.

git.drupalcode.org_project_session_limit_-_merge_requests_6.diff.txt:7: trailing whitespace.
# Session-limit module
git.drupalcode.org_project_session_limit_-_merge_requests_6.diff.txt:63: new blank line at EOF.
+
warning: 2 lines add whitespace errors.
nupur badola’s picture

Status: Needs review » Needs work

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

chetan 11’s picture

Status: Needs work » Needs review

I have added the readme file with latest changes,please review the raised MR.
Thanks

kenyoowen’s picture

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

Hi chetan 11

I reviewed your MR!9 but it's not following the README.md template .

And 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)

For more information visit the documentation.

Thank you.

nitin_lama’s picture

Assigned: Unassigned » nitin_lama
Neha-Verma’s picture

Assigned: nitin_lama » Neha-Verma
Neha-Verma’s picture

Assigned: Neha-Verma » Unassigned
Status: Needs work » Needs review

Update Radme.md file. Please review.

ravi kant’s picture

All required sections are not covered according README.md template suggestions.

ravi kant’s picture

Status: Needs review » Needs work
Neha-Verma’s picture

Status: Needs work » Needs review

Sections are covered according to README.md template suggestions.
Please review.
Thanks

kenyoowen’s picture

Status: Needs review » Needs work

Hi Neha-Verma

I reviewed your changes and noticed that the "Configuration" text has ":" Configuration: colon symbol and maintainer section has only 4 but the module has 6 maintainers.

Thank you.

Neha-Verma’s picture

Status: Needs work » Needs review
kenyoowen’s picture

Status: Needs review » Reviewed & tested by the community

Hi Neha-Verma

I reviewed your changes in MR!9 and it addressed comment #20 and followed the README.md template.

Thank you.

vladimiraus’s picture

Version: 2.0.0-beta2 » 2.0.x-dev
Status: Reviewed & tested by the community » Fixed

Thank you! Merged! 🧁

Status: Fixed » Closed (fixed)

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