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
#12 Screenshot from 2023-06-14 12-05-50.png57.28 KBnitin_lama
#11 AddtoAny_readme.PNG33.96 KBkavitha89
#7 Screenshot 2022-11-13 101418.jpg79.05 KBPracheth
#6 3318723-6.patch2.97 KBNila Hyalij

Issue fork addtoany-3318723

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

Naveen Kumar Reddy created an issue. See original summary.

Naveen Kumar Reddy opened merge request !5

Naveen Kumar Reddy’s picture

Naveen Kumar Reddy commented
Issue summary: View changes
Status: Active » Needs work
Naveen Kumar Reddy’s picture

Naveen Kumar Reddy commented
Status: Needs work » Needs review
Nila Hyalij’s picture

Nila Hyalij commented

Hi @Naveen Kumar Reddy,
Please update md file as per markdown standards.

Nila Hyalij’s picture

Nila Hyalij commented
StatusFileSize
new 3318723-6.patch2.97 KB

I have added patch.
Please review it.

Pracheth’s picture

Pracheth commented
Status: Needs review » Reviewed & tested by the community
StatusFileSize
new Screenshot 2022-11-13 101418.jpg79.05 KB

Reviewed the README.md (latest MR! by Naveen Kumar Reddy #6), The Markdown looks good to me adhering to Drupal markdown practices.

Changing status to Reviewed and Tested by Community.

jay jangid’s picture

jay jangid commented
Status: Reviewed & tested by the community » Needs work

Hi @Pracheth there are still some issues in format of README.md file

- Heading not All Uppercase should be capitalize.
- Project name missing.
- Bulleted lists denoted by dashes (-).
- There are leading spaces

Please check README.md format here README.md template.

So moving it to Need Work

Thank You.

jay jangid’s picture

jay jangid commented
Assigned: Unassigned » jay jangid
jay jangid’s picture

jay jangid commented
Assigned: jay jangid » Unassigned
Status: Needs work » Needs review

Created Updated MR , please review.

Thank you.

kavitha89’s picture

kavitha89 commented
Status: Needs review » Needs work
StatusFileSize
new AddtoAny_readme.PNG33.96 KB

The patch doesn't work and throws the below error:
error: patch failed: README.txt:7
error: README.txt: patch does not apply
error: README.md: No such file or directory
error: README.md: No such file or directory

nitin_lama’s picture

nitin_lama
he/him
Location India
commented
Assigned: Unassigned » nitin_lama
StatusFileSize
new Screenshot from 2023-06-14 12-05-50.png57.28 KB

#kavitha@specbee.com patch applies cleanly. And changes in the MR looks fine to me.

validation

nitin_lama’s picture

nitin_lama
he/him
Location India
commented
Assigned: nitin_lama » Unassigned
Status: Needs work » Needs review
Anmol_Specbee’s picture

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

As mentioned by @nitin_lama above, the patch applies cleanly. Moving it to RTBC.

avpaderno’s picture

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

The README.txt file has been already removed. The MR needs to be updated.

avpaderno’s picture

avpaderno
he/him
Primary language Italian
Location Brescia, 🇮🇹 🇪🇺
commented
Version: 8.x-1.x-dev » 2.0.x-dev

Also, the MR should provided for the 2.0.x branch.

nitin_lama’s picture

nitin_lama
he/him
Location India
commented
Assigned: Unassigned » nitin_lama
nitin_lama’s picture

nitin_lama
he/him
Location India
commented

Addressed the comment in the MR5. I think target branch can be changed by the one who created the MR5. I tried to create a new MR but i was not able to see the branch 2.0.x in the issue fork repo. Therefore, i've updated the changes in the same MR5.

nitin_lama’s picture

nitin_lama
he/him
Location India
commented
Assigned: nitin_lama » Unassigned

  • micropat committed 69013516 on 2.0.x 
    Issue #3318723 by Naveen Kumar Reddy, nitin_lama, Jay Jangid, Nila...
micropat’s picture

micropat commented
Status: Needs work » Fixed

Fixes in the latest release. Thanks all!

Status: Fixed » Closed (fixed)

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