- Issue created by @sunil_lnwebworks
- Status changed to Needs review
8 months ago 11:26am 14 March 2024 I created a readme template where author can easily update the requirements as per need, Please refer to the attached Patch File
- Status changed to Needs work
8 months ago 6:15am 15 March 2024 - ๐ต๐ญPhilippines kenyoOwen
Hi sunil_lnwebworks
I reviewed your patch and it doesn't follow 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
- Status changed to Needs review
8 months ago 7:59am 15 March 2024 Hi @kenyoOwen,
I've made updates to the Readme in accordance with the documentation. Please refer to the Patch File Updated-Readme-File.patch
- Status changed to Needs work
6 months ago 1:59pm 7 May 2024 - ๐ต๐ญPhilippines kenyoOwen
Hi sunil_lnwebworks
I reviewed your updated patch missing a
link to the project page and issue queue
, requirements format is wrong it should be modules if no requirement module it should beThis module requires no modules outside of Drupal core.
.Thank you
- First commit to issue fork.
- Status changed to Needs review
6 months ago 7:52am 13 May 2024 - ๐ฎ๐ณIndia diwakar07
Hi, I have created an MR for the missing README.md file.
Updated the README file based on the suggestion by @kenyoOwen.
Please review. - Status changed to Needs work
6 months ago 6:36am 17 May 2024 - ๐ต๐ญPhilippines kenyoOwen
Hi Diwakar07
I reviewed your changes and it fixes comment #5 I noticed that there is a ditto mark symbol or ("") in the module name in the introduction section and it should be remove and also the Table of Contents need to be replace as
Table of contents
.Thank you
- Status changed to Needs review
6 months ago 7:52am 17 May 2024 - ๐ฎ๐ณIndia diwakar07
Hi @kenyoOwen,
Thanks for the feedback.
I have updated the MR accordingly. Please review. - Status changed to RTBC
6 months ago 6:02am 24 May 2024 - ๐ต๐ญPhilippines kenyoOwen
Hi Diwakar07
I reviewed your changes and I confirmed that it now follows the README.md template.
https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or-distribution-project/documenting-your-project/readmemd-template โThanks,
Ken. - ๐บ๐ธUnited States moshe weitzman Boston, MA
moshe weitzman โ made their first commit to this issueโs fork.
-
moshe weitzman โ
committed 2914b67a on 1.0.x authored by
diwakar07 โ
Issue #3427837: Missing README.md File for the Module
-
moshe weitzman โ
committed 2914b67a on 1.0.x authored by
diwakar07 โ