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 the pattern in the README.md template.

CommentFileSizeAuthor
#18 issues-3341799-Updated-readme-file-extension-in-hook-help.patch589 bytesviren18febs
#6 image focus_readme.PNG11.72 KBkavitha89

Issue fork image_focus-3341799

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

Sonal Gyanani created an issue. See original summary.

Sonal Gyanani opened merge request !1

Sonal Gyanani’s picture

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

Created MR for the issue.
Please review.
Thanks

Rinku Jacob 13 made their first commit to this issue’s fork.

Rinku Jacob 13 opened merge request !2

kavitha89’s picture

kavitha89 commented
Status: Needs review » Reviewed & tested by the community
StatusFileSize
new image focus_readme.PNG11.72 KB

The patch works fine. Moving it to RTBC

avpaderno’s picture

avpaderno
he/him
Primary language Italian
Location Brescia, 🇮🇹 🇪🇺
commented
Priority: Normal » Minor
Status: Reviewed & tested by the community » Needs review
Issue tags: +Needs reroll

MR2 contains changes that are not related to this issue.
Since the last reviewer does not pay much attention to details, it would be better somebody else reviews the MR.

avpaderno’s picture

avpaderno
he/him
Primary language Italian
Location Brescia, 🇮🇹 🇪🇺
commented
Issue tags: -Needs reroll
nupur badola’s picture

nupur badola commented

Reviewed MR!1, the patch is not cleanly applied.

git.drupalcode.org_project_image_focus_-_merge_requests_1.diff.txt:7: trailing whitespace.
# Image Focus Crop
warning: 1 line adds whitespace errors.
nupur badola’s picture

nupur badola commented
Status: Needs review » Needs work

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

frederikvho’s picture

frederikvho
him/he
Primary language Dutch
Location Belgium
commented
Status: Needs work » Needs review

The trailing whitespace on line 1 should be removed now.
Please check !MR1

nupur badola’s picture

nupur badola commented
Status: Needs review » Reviewed & tested by the community

Reviewed MR!1, file is updated as per readme.md file template. Hence, marking it to RTBC.

avpaderno’s picture

avpaderno
he/him
Primary language Italian
Location Brescia, 🇮🇹 🇪🇺
commented
Status: Reviewed & tested by the community » Needs work

The newline is missing at end of the file.

frederikvho’s picture

frederikvho
him/he
Primary language Dutch
Location Belgium
commented
Status: Needs work » Needs review

Thanks @apaderno for this catch, once again.
I fixed it in the latest commit, for MR1

nupur badola’s picture

nupur badola commented
Status: Needs review » Reviewed & tested by the community

@apaderno Reviewed MR!1, the new line is added at the end of the file. Please review.

lamp5’s picture

lamp5
Primary language Polish
Location Rzeszow
commented
Status: Reviewed & tested by the community » Needs work

You have to change the file extension in hook_help.

viren18febs’s picture

viren18febs commented
Status: Needs work » Needs review
StatusFileSize
new issues-3341799-Updated-readme-file-extension-in-hook-help.patch589 bytes

Hi , i have updated the hook help for readme.md, and added a patch for this , please review
Thanks

  • lamp5 committed bfe754e2 on 2.0.x authored by Sonal Gyanani 
    Issue #3341799: Replace README.txt to README.md and update README.md
lamp5’s picture

lamp5
Primary language Polish
Location Rzeszow
commented
Status: Needs review » Fixed

Status: Fixed » Closed (fixed)

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