- Issue created by @aadeshvermaster@gmail.com
- Status changed to Needs review
8 months ago 10:05am 3 May 2024 Hello, I have created a patch for readme.md file. Please review.
Thank you!- Status changed to Needs work
7 months ago 12:36am 13 May 2024 - 🇵ðŸ‡Philippines kenyoOwen
Hi arora.shivani
I only reviewed your patch but not tested it. Introduction heading should be remove
## Introduction
and add link to the project page and issue queue in the introduction section, since there are no outside modules Drupal core the requirements sections should beThis module requires no modules outside of Drupal core.
, and installation section should beInstall as you would normally install a contributed Drupal module. For further information, see [Installing Drupal Modules](https://www.drupal.org/docs/extending-drupal/installing-drupal-modules).
Thanks,
Ken. - First commit to issue fork.
- Status changed to Needs review
7 months ago 11:33am 13 May 2024 - 🇮🇳India diwakar07
Hi kenyoOwen,
I have updated the README.md according to the changes suggested.
Please review. - Status changed to Needs work
7 months ago 8:09am 20 May 2024 - 🇵ðŸ‡Philippines kenyoOwen
Hi Diwakar07
I'm not sure what happened but, when I opened your MR!4 the README.md file rendered this text:
File suppressed by a .gitattributes entry or the file's encoding is unsupported.
Thanks,
Ken. - Status changed to Needs review
7 months ago 11:45am 20 May 2024 - 🇮🇳India diwakar07
Hi @kenyoOwen,
There was an issue with the encoding of the README.txt file.
Deleted the README.txt file and created a new README.md file. Now the MR looks good.
Please review. - Status changed to Needs work
7 months ago 7:42am 3 June 2024 - 🇵ðŸ‡Philippines kenyoOwen
Hi Diwakar07
I reviewed the MR!4 and the table of content (TOC) isn't following the format
## Table of Contents - [Requirements](#requirements) - [Recommended Modules](#recommended-modules) - [Installation](#installation) - [Configuration](#configuration) - [Troubleshooting & FAQ](#troubleshooting--faq)
README format
## Table of contents - Requirements - Recommended modules - Installation - Configuration - Troubleshooting - FAQ - Maintainers
Also as per README
TOCs are optional but appreciated for lengthy README files.
You can either remove or change the format of the TOC of the module.Thanks
- Status changed to Needs review
7 months ago 8:01am 3 June 2024 - 🇮🇳India diwakar07
Hi,
I have updated the MR accordingly. Please review. - Status changed to Needs work
6 months ago 7:42am 26 June 2024 - 🇵ðŸ‡Philippines kenyoOwen
Hi Diwakar07
I reviewed your changes and it didn't fix the comment #9. The only issue that wasn't fixed was the TOC name. The README.md TOC name is
## Table of contents
while in your MR the name of it is## Table of Contents
, "contents" should be a small letter.Thanks.
- Status changed to Needs review
5 months ago 5:58am 15 July 2024 - Status changed to RTBC
5 months ago 1:23am 16 July 2024 - 🇵ðŸ‡Philippines kenyoOwen
Hi Diwakar07
I reviewed your changes and it fixed the comment #11. README.md file is now following the README.md template.
https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or... →Thanks