Problem/Motivation

We could be using README.md instead of README.txt to make use of the nicer rendering via markdown.

Steps to reproduce

We could be using README.md instead of README.txt following the README.md template.

Also, follow the pattern in the README.md template.
https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or...

Issue fork colorpalette-3365045

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

Akshay kashyap created an issue. See original summary.

Akshay kashyap opened merge request !3

Akshay kashyap closed merge request !3

akshay kashyap’s picture

akshay kashyap commented
Issue summary: View changes
akshay kashyap’s picture

akshay kashyap commented
Status: Active » Needs review
akshay kashyap’s picture

akshay kashyap commented
Assigned: akshay kashyap » Unassigned
rushikesh raval’s picture

rushikesh raval commented
Status: Needs review » Needs work

I have reviewed your changes in README.md You have just copied Readme.txt file to README.md but need to rearrange sections as per

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

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

anjali mehta’s picture

anjali mehta commented
Status: Needs work » Needs review

Kindly review the changes.
Thank you.

abhaysaraf’s picture

abhaysaraf commented
Status: Needs review » Needs work

Thank you Anjali for updating the content of this file with the correct format as per https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or....

I would like to merge it but there is no PR, can you raise one? If possible, please accommodate suggestions added within the commit (at https://git.drupalcode.org/issue/colorpalette-3365045/-/commit/bd4e4493d...). Thank you.

rushikesh raval’s picture

rushikesh raval commented

Still needs needs some work. it is not as per recommendation by Drupal.
Requirement & configuration section missing.

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

anjali mehta’s picture

anjali mehta commented
Assigned: Unassigned » anjali mehta
Category: Support request » Task

Thank you for the review. I will work on the suggestions.

Anjali Mehta opened merge request !5

anjali mehta’s picture

anjali mehta commented
Assigned: anjali mehta » Unassigned
Status: Needs work » Needs review

Hello @abhaysaraf
Created MR5 to update the README.md file as per the Drupal READMe.md template. Added all the suggestions addressed in #10.
Kindly review the changes .

Thank you.

rushikesh raval’s picture

rushikesh raval commented
Status: Needs review » Needs work

@Anjali Mehta Thanks for your contribution and MR. Now it format is as per Drupal Requirement. But Maintainers section is missing in this MR. So I suggest to add this section with name of maintainers.

anjali mehta’s picture

anjali mehta commented
Status: Needs work » Needs review

Hello @rushiraval,

Thank you for the review. Please follow comment #10, as it was suggested by the maintainer of this module that:

"With every maintainer joining or moving out, this file would require an update; hence, let's ignore."

Additionally, please note that this section is optional, as stated in the Drupal README.md template. Therefore, it's not mandatory to include this section in the readme.md file.

Considering this, I'm changing the status back to NR.

Thank you.

rushikesh raval’s picture

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

@Anjali Mehta Thanks for your contribution. I have review MR!1 and MR!1 is as per drupal recommendation.
I am changing status to RTBC.

abhaysaraf’s picture

abhaysaraf commented

abhaysaraf’s picture

abhaysaraf commented
Status: Reviewed & tested by the community » Fixed

MR-5 merged. Thank you everyone for supporting the module.

Status: Fixed » Closed (fixed)

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