Instead of README.txt, we could utilize README.md for better rendering through markdown formatting.

Given our transition to GitLab, it's advisable to opt for Markdown over plain .txt files for our documentation.

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

Issue fork give-3425232

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

vishal-yadav created an issue. See original summary.

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

rishabjasrotia opened merge request !4

rishabjasrotia’s picture

rishabjasrotia commented
Assigned: Unassigned » rishabjasrotia
Status: Active » Needs review
kenyoowen’s picture

kenyoowen commented
Component: Code » Documentation
Status: Needs review » Needs work

Hi rishabjasrotia

I reviewed your MR!4 replacing txt to md isn't correct, the README.md file should be following the format of the README.md template.

Drupal recommends the following README sections:

Project name and introduction (required)
Table of contents (optional)
Requirements (required)
Recommended modules (optional)
Installation (required, unless a separate INSTALL.md is provided)
Configuration (required)
Troubleshooting & FAQ (optional)
Maintainers (optional)

Thank you

rishabjasrotia’s picture

rishabjasrotia commented
Status: Needs work » Needs review
kenyoowen’s picture

kenyoowen commented
Status: Needs review » Needs work

Hi rishabjasrotia

I reviewed your changes and still missing a link to the project page and issue queue in Project name and introduction section and the installation section the link should be replaced to https://www.drupal.org/docs/extending-drupal/installing-drupal-modules and format is wrong for install section it should be For further information, see and maintainer format is wrong also it should be 

- Daniel F. Kudwien - [sun](https://www.drupal.org/u/sun)
- Peter Wolanin - [pwolanin](https://www.drupal.org/u/pwolanin)

.

Thank you

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

deepak5423’s picture

deepak5423 commented
Assigned: rishabjasrotia » Unassigned

@kenyoOwen @vishal-Yaduvanshi please review the changes.

deepak5423’s picture

deepak5423 commented
Status: Needs work » Needs review
a.aaronjake’s picture

a.aaronjake commented
Status: Needs review » Reviewed & tested by the community

Hi @deepak5423,

Applied your MR !4, all concerns about the standard format is confirmed fixed.

Will change the status to RTBC.
Thank you.

kenyoowen’s picture

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

Hi deepak5423

I reviewed your changes and you should remove the URL for the module in the Project name and Introduction section which is this one [Give](https://www.drupal.org/project/give) and wrong format in the maintainer section it should be 

## Maintainers

- Daniel F. Kudwien - [sun](https://www.drupal.org/u/sun)
- Peter Wolanin - [pwolanin](https://www.drupal.org/u/pwolanin)
- Stefan M. Kudwien - [smk-ka](https://www.drupal.org/u/smk-ka)
- Dave Reid - [Dave Reid](https://www.drupal.org/u/dave-reid)

Thanks,
Ken.

deepak5423’s picture

deepak5423 commented
Status: Needs work » Needs review

@kenyoOwen I have updated the MR according to the standards.
Please review

kenyoowen’s picture

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

Hi deepak5423

I reviewed your changes and it fixed the issues mentioned in comment #12. The README.md file now follows the README.md template.

Thanks.

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

  • mlncn committed 0b33fac3 on 2.0.x authored by rishabjasrotia 
    Issue #3425232 by rishabjasrotia, deepak5423, kenyoowen, mlncn: Please...
mlncn’s picture

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

Status: Fixed » Closed (fixed)

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