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

Now that we've moved to GitLab, we should probably use Markdown instead of plain .txt files for our documentation

CommentFileSizeAuthor
#10 README.md.png184.19 KBkenyoowen
#5 Pager_infinite_roll.png221.1 KBnupur badola
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

Sonal Gyanani created an issue. See original summary.

Sonal Gyanani’s picture

Assigned: Sonal Gyanani » Unassigned
Status: Active » Needs review

Created MR for the issue.
Please review.

nayana_mvr’s picture

Verified MR!1 and it looks good to me. It follows the README.md template format. Need RTBC+1.

nupur badola’s picture

Status: Needs review » Reviewed & tested by the community
StatusFileSize
new221.1 KB

Patch is working and marking it to RTBC.

avpaderno’s picture

Priority: Normal » Minor
Status: Reviewed & tested by the community » Needs review

It would be better if somebody else reviews the MR.

nupur badola’s picture

Reviewed MR!1, the patch is not cleanly applied.
1. Format of maintainer section is not correct.

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

priya_degwekar’s picture

Hi, I've fixed the maintainer section in this commit
Please review.. thanks!

kenyoowen’s picture

Status: Needs review » Needs work
StatusFileSize
new184.19 KB

Hi Priya_Degwekar

I tested and reviewed your MR!1 and it doesn't follows the README.md template. In the configuration section don't just add the configuration settings 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."