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
#9 readme-md-convert-3332138-9.patch2.9 KBistryker
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

Rashmi Gaurana created an issue. See original summary.

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

vimal_nadar’s picture

Assigned: Unassigned » vimal_nadar
Status: Active » Needs review

@_pratik_ you have not updated the status to needs review I will update the status and review your MR

vimal_nadar’s picture

Assigned: vimal_nadar » Unassigned
Status: Needs review » Needs work

@_pratik_ the MR raised does not satisfies all formatting suggested in https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or...
You need to add #Requirements which is a required section in README.md file.
Also all the table of contents heading should start with ## but your table of contents heading has only one #.

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

dharmeshbarot’s picture

Status: Needs work » Needs review
vimal_nadar’s picture

Status: Needs review » Reviewed & tested by the community

@dharmeshbarot I have reviewed MR 6 and it satisfies all the Drupal standards for README.md file.

Moving it to RTBC.

istryker’s picture

Status: Reviewed & tested by the community » Active
StatusFileSize
new2.9 KB

Modified it a little before committing to the 1.0.x branch.

  • iStryker committed 7528b7af on 1.0.x
    Issue #3332138 by _pratik_, dharmeshbarot, iStryker: Replace README.txt...
istryker’s picture

Status: Active » Fixed

Comitted #9

Status: Fixed » Closed (fixed)

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