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...

Issue fork gtranslate-3322432

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
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Raghavendra A M created an issue. See original summary.

Raghavendra A M opened merge request !9

Raghavendra A M’s picture

Raghavendra A M CreditAttribution: Raghavendra A M as a volunteer and at ITT Digital commented
Status: Active » Needs review

Committed according to the proposed solution.

Please review it.

vimal_nadar’s picture

vimal_nadar CreditAttribution: vimal_nadar at Valuebound for Valuebound commented
Assigned: Unassigned » vimal_nadar

I will review this

vimal_nadar’s picture

vimal_nadar CreditAttribution: vimal_nadar at Valuebound for Valuebound commented
Assigned: vimal_nadar » Unassigned
Status: Needs review » Needs work

@Raghavendra A M I reviewed MR 9 and it does not satisfies all formatting suggested in https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or...
There is Project name and Requirements missing in the README.md file which is a required sections.

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

bandanasharma’s picture

bandanasharma CreditAttribution: bandanasharma as a volunteer and at gai Technologies Pvt Ltd for gai Technologies Pvt Ltd commented
Status: Needs work » Needs review

The Readme.md file has been updated according to the drupal standard.

vimal_nadar’s picture

vimal_nadar CreditAttribution: vimal_nadar at Valuebound for Valuebound commented
Status: Needs review » Needs work

@bandanasharma we need to add Project name in the top of the README.md file which is missing. And #Requirements section is also missing in the file.

You can refer this link https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or... to see which all sections is required.

akshaydalvi212’s picture

akshaydalvi212 CreditAttribution: akshaydalvi212 at QED42 for Drupal India Association commented
Assigned: Unassigned » akshaydalvi212

I will update the MR and README.md file as per the suggestion provided.

akshaydalvi212’s picture

akshaydalvi212 CreditAttribution: akshaydalvi212 at QED42 for Drupal India Association commented
Assigned: akshaydalvi212 » Unassigned
Status: Needs work » Needs review

Updated the MR kindly review.

vimal_nadar’s picture

vimal_nadar CreditAttribution: vimal_nadar at Valuebound for Valuebound commented
Status: Needs review » Needs work

@akshaydalvi212 Project name in the top of the README.md should be mentioned in single # you have used ## for that. Other than that everything looks fine.

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

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

dharmeshbarot’s picture

dharmeshbarot CreditAttribution: dharmeshbarot at Atlas Softweb Pvt Ltd commented
Status: Needs work » Needs review
vimal_nadar’s picture

vimal_nadar CreditAttribution: vimal_nadar at Valuebound for Valuebound commented
Status: Needs review » Reviewed & tested by the community

I have reviewed the MR 9 and everything looks fine according to the Drupal standards.
Moving it to RTBC.