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

Issue fork livechat-3319618

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

Naveen Kumar Reddy created an issue. See original summary.

Naveen Kumar Reddy’s picture

Issue summary: View changes
Status: Active » Needs review
StatusFileSize
new533 bytes
komalparmar’s picture

StatusFileSize
new2.14 KB

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

Manoj Raj.R’s picture

Status: Needs review » Needs work

Working on some minor fixes and adding Maintainers section.

Manoj Raj.R’s picture

Status: Needs work » Needs review

This should give proper introduction and maintainers section with proper markdown format.

https://git.drupalcode.org/project/livechat/-/merge_requests/1/diffs

Please review

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

markie’s picture

Status: Needs review » Fixed

Thanks for the merge request. I have committed it and will start a release plan for the next version.

Manoj Raj.R’s picture

Status: Fixed » Needs review

Hi @markie

There is new change in the Readme file as per Drupal standard.

https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or...

Updated as per the README.md template.

Please review.

nupur badola’s picture

Status: Needs review » Needs work

Getting warning :
warning: README.md has type 100644, expected 100755

also , few points needs to corrected.
1. Text manually word-wrapped within around 80 cols.
2. Few points are given in table of contents but not explained in details , no section available for them.

Below are the recommended section-
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)

Anjali Mehta made their first commit to this issue’s fork.

anjali mehta’s picture

Status: Needs work » Needs review
nupur badola’s picture

Status: Needs review » Needs work

Still getting warning of:
warning: README.md has type 100644, expected 100755

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

sakthi_dev’s picture

Status: Needs work » Needs review
StatusFileSize
new74.77 KB

Please review updated the permission.

nupur badola’s picture

Status: Needs review » Needs work

Still getting the same warning:
warning: README.md has type 100644, expected 100755

ravi kant’s picture

Title: READ.txt to READ.MD » README.txt to README.MD
ravi kant’s picture

Status: Needs work » Needs review

I have fixed the issues of review report so now review again.

nupur badola’s picture

Status: Needs review » Needs work

@ravikant
Still getting the same warning:
warning: README.md has type 100644, expected 100755

ravi kant’s picture

StatusFileSize
new120.13 KB

@Nupur Badola
The error is not generating for me.
and patch is applying as designed.

patch

ravi kant’s picture

Status: Needs work » Needs review

@Nupur Badola
Lets wait for test by other testers.

silvi.addweb made their first commit to this issue’s fork.

silvi.addweb’s picture

Hi, MR 3 applied cleanly

modules/custom/livechat# curl https://git.drupalcode.org/project/livechat/-/merge_requests/3.diff | git apply -v
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100  3653    0  3653    0     0   4077      0 --:--:-- --:--:-- --:--:--  4072
Checking patch README.md...
Applied patch README.md cleanly.

I have fixed below phpcs issue in README.md and committed file. Please review it

modules/custom/livechat/README.md 

PHPCBF RESULT SUMMARY
-----------------------------------------------------------------------------------------------------------------------------
FILE                                                                                                         FIXED  REMAINING
-----------------------------------------------------------------------------------------------------------------------------
/home/addweb/Drupal8-vagrant/web/web/contribution/d9_contribution2/web/modules/custom/livechat/README.md     1      0
-----------------------------------------------------------------------------------------------------------------------------
A TOTAL OF 1 ERROR WERE FIXED IN 1 FILE
-----------------------------------------------------------------------------------------------------------------------------

Time: 51ms; Memory: 10MB