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.

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

CommentFileSizeAuthor
#12 351019-replace-readme.txt-with · Issue forks _ file_utility-3351019_test_OK.png264.49 KBrushikesh raval
#9 3351019-replace-readme.txt-with · Issue forks _ file_utility-3351019.png229.61 KBrushikesh raval
#8 3351019-after.png319.52 KBclarkssquared
#8 3351019-applying-MR.png33.84 KBclarkssquared
#8 3351019-before.png198.22 KBclarkssquared

Issue fork file_utility-3351019

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:

About issue forks

Comments

gowthami reddy created an issue. See original summary.

gowthami reddy’s picture

gowthami reddy commented
Status: Active » Needs review

As per md format updated the readme file

please review the same

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

nayana_mvr opened merge request !1

nayana_mvr’s picture

nayana_mvr commented

Verified the changes in the branch. There were some format issues which I have corrected in the new commit. Also, updated few more details and created MR!1. Please review. Thanks

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

nupur badola’s picture

nupur badola commented

Patch is working but getting the warning.

warning: README.txt has type 100644, expected 100755
clarkssquared’s picture

clarkssquared commented
Status: Needs review » Reviewed & tested by the community
StatusFileSize
new 3351019-before.png198.22 KB
new 3351019-applying-MR.png33.84 KB
new 3351019-after.png319.52 KB

Hi

I applied the updated MR to my local with Drupal 9.5.9 and I confirmed that it applied cleanly and replaced REAMDE.txt with README.md, and below is the result that is showing in my terminal as I apply the MR

% Total % Received % Xferd Average Speed Time Time Time Current
Dload Upload Total Spent Left Speed
100 3874 0 3874 0 0 4142 0 --:--:-- --:--:-- --:--:-- 4215
Checking patch README.md...
Checking patch README.txt...
Applied patch README.md cleanly.
Applied patch README.txt cleanly.

Please also look at the screenshots attached for reference.

Thank you

rushikesh raval’s picture

rushikesh raval commented
Status: Reviewed & tested by the community » Needs work
StatusFileSize
new 3351019-replace-readme.txt-with · Issue forks _ file_utility-3351019.png229.61 KB

Text in readme.md file exceeding the 80 text in line limit. It should be limite as per REadme.md Template guidelines

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

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

elber’s picture

elber
Primary language Portuguese, Brazil
Location Brazil
commented
Status: Needs work » Needs review
rushikesh raval’s picture

rushikesh raval commented
Status: Needs review » Reviewed & tested by the community
StatusFileSize
new 351019-replace-readme.txt-with · Issue forks _ file_utility-3351019_test_OK.png264.49 KB

I have reviewed readme.md file of MR!1. It is as per required format.
so I am moving this isssue to RTBC.