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
#8 Particles_orange.png172.3 KBnupur badola
#6 3365602-5.patch2.28 KBnitin_lama
#5 Screenshot from 2023-06-09 18-14-08.png18.24 KBnitin_lama
#3 3365602 - after.png430.82 KBkenyoowen
#3 3365602 - before.png404.98 KBkenyoowen
#2 3365602-2.patch2.18 KBpanwarjatin

Issue fork particles_orange-3365602

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

panwarjatin created an issue. See original summary.

panwarjatin’s picture

panwarjatin commented
Status: Active » Needs review
StatusFileSize
new 3365602-2.patch2.18 KB

Changed README.txt to README.md please review it.

Thank you.

kenyoowen’s picture

kenyoowen commented
Status: Needs review » Needs work
StatusFileSize
new 3365602 - before.png404.98 KB
new 3365602 - after.png430.82 KB

Hi panwarjatin

I reviewed and applied your MR and the README.txt isn't replaced with README.md and it is not following the README.md template Please see the screenshots attached.

Thank you.

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
Status: Needs work » Needs review
StatusFileSize
new Screenshot from 2023-06-09 18-14-08.png18.24 KB

validation

@kenyoOwen Patch applies cleanly and README.txt is replaced with README.md.

nitin_lama’s picture

nitin_lama
he/him
Location India
commented
StatusFileSize
new 3365602-5.patch2.28 KB

Updated patch as per README.md template.

nitin_lama’s picture

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

nupur badola commented
Status: Needs review » Reviewed & tested by the community
StatusFileSize
new Particles_orange.png172.3 KB

Patch is working and marking it to RTBC.

akshay kashyap’s picture

akshay kashyap commented

@nitin_lama

Thanks for the Work.

I have reviewed and tested the #7 patch looks good Replace the README.txt file with README.md now

RTBC++

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

harshita mehna’s picture

harshita mehna commented

Can anyone create MR for the same?

akshay kashyap’s picture

akshay kashyap commented
Assigned: Unassigned » akshay kashyap

@Harshita mehna okey will create.

Thanks

Akshay kashyap opened merge request !7

raveen_thakur51’s picture

raveen_thakur51 commented

@Akshay
I reviewed the README.md, it's included all the Drupal recommends sections and formatting.
And Thank you.

priya_degwekar’s picture

priya_degwekar commented

Hi @Harshita, Please check the commit.
Did some changes according to the README.md template Documentation.
Thanks :)

harshita mehna’s picture

harshita mehna commented
Status: Reviewed & tested by the community » Fixed

@all, Thanks for your contribution.

Status: Fixed » Closed (fixed)

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