Problem/Motivation

There was no Readme File for this module

Steps to reproduce

Proposed resolution

Creating a start for the Readme file

CommentFileSizeAuthor
#3 README.md1.23 KB_pratik_
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

dineshreddymathuku created an issue. See original summary.

_pratik_’s picture

Assigned: Unassigned » _pratik_
_pratik_’s picture

StatusFileSize
new1.23 KB
_pratik_’s picture

Assigned: _pratik_ » Unassigned

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

elber’s picture

Assigned: Unassigned » elber

elber’s picture

Assigned: elber » Unassigned
Status: Active » Needs review

Hi made the change requested in scope of the issue also I fixed some phpcs errors and I updated the README following this pattern (https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or...)

dineshreddymathuku’s picture

Hi #3 is good and #8 is more helpful
thanks

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

Manoj Raj.R’s picture

Updated Readme file with Proper URL alias

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

dineshreddymathuku’s picture

Hi #3 and #10 is good for me
Thanks for your Response

damienmckenna’s picture

Status: Needs review » Needs work

The headings need to be changed to follow Markdown syntax, and the "Contents of this file" portion is not necessary.

elber’s picture

Hi @DamienMckenna for me it's everything ok, because I followed the drupal guide. (https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or...)

damienmckenna’s picture

The existing documentation only describes the suggested syntax for a plaintext README.txt file, not a formatted README.md file, specifically:

It is recommended to take advantage of the newer Markdown format and create a README.md files (instead of README.txt). If you do so, you may want to use more Markdown-features than those used in the example snippets in this template. For instance, Markdown let you create hyperlinks that can be clicked when the README.md is rendered in GitLab or by a compatible program (e.g. Advanced Help).

nitin_lama’s picture

The Markdown coding standards are still discussed.

avpaderno’s picture

The Drupal coding standards, under Naming Conventions / File names, says:

All documentation files should have the file name extension ".txt" to make viewing them on Windows systems easier. Also, the file names for such files should be all-caps (e.g. README.txt instead of readme.txt) while the extension itself is all-lowercase (i.e. txt instead of TXT).

damienmckenna’s picture

@apderno: That seems to be out of date and misses the point of the newer Markdown syntax files that Gitlab supports; I updated the docs page to reference the newer standard.

elber’s picture

Assigned: Unassigned » elber

Sorry, I will update this file using markdown sintax

elber’s picture

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

I did the requested changes in the comment #14 please revise.

  • matio89 committed 605af68 on 8.x-2.x authored by elber
    Issue #3315777: Replace README.txt with README.md
    
matio89’s picture

Status: Needs review » Fixed

Thanks all,
Code merged.

matio89’s picture

Status: Fixed » Closed (fixed)