Hi prudloff
Updated the M.R. and followed your suggestions. Added ```javascript
and ```yaml
Thanks
kenyoowen → created an issue.
kenyoowen → created an issue.
Hi prudloff
Updated the M.R. and followed your suggestions. I'll take note also on this one. https://docs.gitlab.com/ee/user/markdown.html#syntax-highlighting
Thanks
kenyoowen → created an issue.
kenyoowen → made their first commit to this issue’s fork.
Hi avpaderno
I fixed the comments you added to the M.R.
Please review,
Thanks.
kenyoowen → made their first commit to this issue’s fork.
Hi avpaderno,
I updated the introduction text.
Thanks
Didn't add the Table of contents
section since it's a small README.md file.
Thanks
kenyoowen → made their first commit to this issue’s fork.
kenyoowen → created an issue.
Updating the version to 2.2.2 since, I need to refractor my changes to 2.2.x
Hi avpaderno
I wrapped the text to 80 characters and removed the recommended module section since it has "N/A".
Thanks
kenyoowen → made their first commit to this issue’s fork.
kenyoowen → created an issue.
Hi hamzadwaya
I reviewed your README.md changes on this commit 42521268 and it doesn't follows the REAMDE.md template.
README sections
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)
Please also take note that in order for your README to be reviewed you should create a M.R. This is as per avpaderno on this R EADME.md issue. 📌 README.md missing Fixed
Transitioning this to active state since no Merge Request yet.
Thanks
Hi kuzyawkk
I reviewed your changes in MR!8 and the changes are now wrapped to 80 cols. This is now good for me.
RTBC +1
Thanks.
Hi siddhraj
I reviewed your new patch in comment #8 and it now follows the README.md template. → And tested the patch on my local and it's working.
Thanks
This newly created M.R. is missing a fix for #3, the card inset media.
kenyoowen → created an issue.
kenyoowen → created an issue.
Hi siddhraj
I reviewed your new patch seo_analyzer_readme-3462417-6.patch
and it's missing a requirements section which is required by README Requirements (required)
. And make sure text are manually word-wrapped within around 80 cols. Please also transition the status to needs review, if you added a new patch for review.
Thanks
kenyoowen → created an issue.
kenyoowen → created an issue.
Hi cosolom
I reviewed your changes in MR!122 and the configuration now looks good on my end.
Thanks
https://git.drupalcode.org/project/provus/-/merge_requests/213
M.R for the 2.2.x-dev to test the updated templates.
kenyoowen → created an issue.
Hi siddhraj
I reviewed your patch and it seems missing a issue queue link in the introduction, requirements sections, and configuration, features, and maintainers section should have two heading prefixes only. Maintainer has a wrong format, it should be - Daniel F. Kudwien - [sun](https://www.drupal.org/u/sun)
. And I think it's better to have an M.R. rather than a patch.
Thanks.
kenyoowen → created an issue.
kenyoowen → created an issue.
kenyoowen → created an issue.
kenyoowen → created an issue.
kenyoowen → created an issue.
kenyoowen → created an issue.
kenyoowen → created an issue.
kenyoowen → created an issue.
kenyoowen → created an issue.
kenyoowen → created an issue.
Hi sujan shrestha
I reviewed the README.md file added https://git.drupalcode.org/project/ga4_google_analytics/-/commit/8f2de48....
It seems it doesn't follow the README.md template → .
README sections
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)
Thanks
Hi mohd sahzad
I reviewed your MR!1 and noticed that some sections don't follow the README template.
Table of contents format should be
## Table of contents
- Requirements
- Recommended modules
- Installation
- Configuration
- Troubleshooting
- FAQ
- Maintainers
The requirements section format should be if no modules required
## Requirements
This module requires no modules outside of Drupal core.
Maintainer sections should be
## Maintainers
- Daniel F. Kudwien - [sun](https://www.drupal.org/u/sun)
- Peter Wolanin - [pwolanin](https://www.drupal.org/u/pwolanin)
And make sure text are wrapped within around 80 cols
Thanks
Hi alorenc
I reviewed your MR!15 and noticed that your README changes don't follow
README.md format. →
These are the sections that Drupal Recommends
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)
Kindly also add a table of contents to the README since the current README has a lot of sections.
Thanks.
Hi cosolom
In the new configuration section, you added on the README, for me. For better readability, I think this would be better You can configure all available payment methods for the Payment Element in the Stripe dashboard. The main condition is that these payment methods should be used for “Single use” if you want to include options like Klarna, Afterpay, or Clearpay.
Thanks
Hi nfabing
I reviewed your MR!17 for the README.md. It seems it doesn't follow the README.md template.
Need to arrange the README the CONTENTS OF THIS FILE
should be below the introduction and the CONTENTS OF THIS FILE
should be replace to Table of contents
.
For Reference:
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)
Thanks
Hi kuzyawkk
Can you also wrapped the updated Project Description
, as per README
Text manually word-wrapped within around 80 cols
Thanks
Hi mtift
The two maintainers are not following the format, it's missing a hyphen (-)
- Matthew Tift [mtift](https://www.drupal.org/u/mtift)
- Pablo López [plopesc](https://www.drupal.org/u/plopesc)
I'm not sure if a dot is needed on the configuration sentence, you can add it if it's relevant.
- A "Dashboard Text" block with a text field for custom text
- A "My own drafts" view to display the content drafts for current user
Thanks
Hi nilesh.addweb
I reviewed your MR!4 and noticed that the maintainer section is missing some maintainers. These are the maintainers that are missing Chaitanya Dessai (chaitanyadessai
and jyoti (nehajyoti)
Thanks
Hi KuzyaWkk
I reviewed your MR!8 and for better readability in Project Description
section, this would be better for me
The accessibility tool module is designed to help people with visual disabilities view content. It allows users to choose between pre-selected contrasts and to zoom in and out using highly visible buttons. We have also included an optional help button that links to your site’s help page.
Thanks
Hi deepak5423
I reviewed your changes and it fixed the comment #11 issue. Readme.md now follows the README template.
https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or... →
Thanks
Hi mtift
I reviewed your MR!13, for the ## Introduction
it should be the Module name or project name which is #Dashboard
with one hastag only, remove hyphen in Project link and issue queue link - For the description of the module visit the
, for the issue queue link remove the ?categories=All
, and wrong format in 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)
Thanks
Hi ravi kant
I reviewed your MR!7 and in Project name no need to add a apostrophe 'QR code field'
and missing dots in configuration section.
The QR code filed module provides a block 'QR image block' and field type 'QR field'
**QR image block** - It can added in any region
**QR field** - Field type 'QR field' can added as drupal other field
Thanks
Hi Mohd Sahzad
I reviewed your MR!3 and it seems the Installation
section is not wrapped around 80 cols, as per README.md it needs to be wrapped in 80.
Text manually word-wrapped within around 80 cols
Thanks
Hi gajanan.wasnik
I reviewed the MR!1 the Project page and Issue queue is missing spacing.
It should be
For a full description of the module, visit the
[project page](https://www.drupal.org/project/admin_menu).
Submit bug reports and feature suggestions, or track changes in the
[issue queue](https://www.drupal.org/project/issues/admin_menu).
Thanks.
Hi chaitanyadessai
I installed the module and reviewed your REAMDE.md file, and it seems doesn't follow the README.md template. Missing some sections that are required in the Readme template, for example, the "Requirements" section.
https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or... →
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)
Thanks
kenyoOwen → changed the visibility of the branch 3463017-styles-block-library to hidden.
It seems the tugboat isn't triggered. Creating a new branch.
Hi sarwan_verma
I reviewed your MR!11 and it seems your README.md file isn't following the README.md template.
https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or... →
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)
Thanks
kenyoOwen → changed the visibility of the branch 3463017-allow-for-existing to hidden.
Creating a new branch to trigger the tugboat environment.
Hi sarwan_verma
I reviewed your MR!3 and the status is Draft and the README.md file of it isn't following the README.md template.
https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or... →
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)
Thanks
Hi deepak5423
I reviewed MR!5 the added project page and issue queue should not be in bulleted list, it should be formatted like this as per README.md.
For a full description of the module, visit the
[project page](https://www.drupal.org/project/admin_menu).
Submit bug reports and feature suggestions, or track changes in the
[issue queue](https://www.drupal.org/project/issues/admin_menu).
Thanks
kenyoOwen → changed the visibility of the branch 3462518-testimonial-theming to hidden.
Creating a new branch to trigger the tugboat environment.
kenyoOwen → changed the visibility of the branch 3461948-style-ala-link to hidden.
Creating a new branch to trigger the tugboat environment.
https://git.drupalcode.org/issue/provus-3461948/-/tree/3461948-advanced-...
kenyoOwen → made their first commit to this issue’s fork.
Please review my new patch, the previous patch doesn't work.
I only use this command in my CLI git diff [file-name] > ./file-name.patch
Please review new patch, previous patch is a mistake of mine.
Thanks
Please review the patch.
kenyoOwen → created an issue.
kenyoOwen → changed the visibility of the branch 3461948-advanced-settings-inside to hidden.
kenyoOwen → created an issue.
kenyoOwen → created an issue.
kenyoOwen → created an issue.
Hi Andrii Momotov
I reviewed your MR!3 and the requirements section and installation format have the wrong format.
README.md template format.
## Requirements
This module requires the following modules:
- [Views](https://www.drupal.org/project/views)
- [Panels](https://www.drupal.org/project/panels)
Installation format:
Install 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).
The same with the configuration, troubleshooting, and maintainer sections.
Thanks.
Hi amanmansuri72
I reviewed you MR!2 but it doesn't follow the README.md template.
https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or... →
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)
Thanks
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
Hi ankitv18
I reviewed the MR!61 and it seems to be missing the configuration
section and requirements
section which both are required as per the README.md template. Missing also a table of content section, for me it's needed since the README file is quite long and the Project name and introduction
is missing a link to the project page and issue queue.
https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or... →
Thanks
Hi Arijit Acharya
I reviewed your changes in MR!2 and for the configuration section you can remove Enable the module at Administration > Extend.
since that part is in the installation section. As per README.md template configuration should be Ordered lists use "1", for easier updates and to avoid errors
, you can also remove this one To use this shipping method just try to follow next steps:
Thanks.
Hi sarwan_verma
I reviewed the MR!7 and it has a missing section especially the required one as per the README.md template.
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)
Thanks
kenyoOwen → created an issue.
Hi nilesh.addweb
I reviewed your MR!4 and I have some concerns about the readability of the module.
you can easily copy the machine name of a field with a single click.
to you can easily copy a field's machine name with a single click.
Visit content type you want to add copy field feature and edit content type page admin/structure/types/manage/article, here you can enable or disable copy field feature.
to Visit the content type you want to add copy field feature and edit the content type page admin/structure/types/manage/article, here you can enable or disable copy field feature.
After enable this you can see new tab Manage Copy field on admin/structure/types/manage/article
to After enabling this you can see a new tab Manage Copy field on admin/structure/types/manage/article
Copy field machine name to clipboard and past it whereever you want
to Copy field machine name to clipboard and past it wherever you want
Hi Indranil Roy
I reviewed MR!4 and it doesn't follow the README.md template format.
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)
Thanks
Hi
I reviewed MR!5 and the Project name and introduction
section it's missing a link to the project page and issue queue, and remove the duplication of the 'of' word This will mimic the behavior of of optional end
.
Thanks.
Hi silvi.addweb
I reviewed the MR!1 and the maintainer section has the wrong format.
It should be
## Maintainers
- Daniel F. Kudwien - [sun](https://www.drupal.org/u/sun)
- Peter Wolanin - [pwolanin](https://www.drupal.org/u/pwolanin)
Thanks
kenyoOwen → created an issue.
Hi Hritick
I reviewed your MR!54 and it doesn't follow the README.md template. https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or-distribution-project/documenting-your-project/readmemd-template →
These are the section Drupal Readme recommends.
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)
Thanks.
Hi silvi.addweb
I reviewed your changes in MR!2 and it fixed comment #14. The README.md 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.
Hi nilesh.addweb
I reviewed your MR!2 and for configuration no need to say Go to Administration » Extend and Enable module.
since that is covered in the installation section and the #3 in configuration this should be big letter visit
to "Visit"
Thanks.
Hi ankitv18
Thank you for the review. I tested your code in comment #8 and it works the same as the current change, but I think we stick to the current change since it has better readability and is also more maintainable for me.
Thanks.
Hi abhiyanshu
I reviewed your MR!12 and it doesn't follow the README.md template.
https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or-distribution-project/documenting-your-project/readmemd-template →
An example of your MR!12 that isn't following the README.md template is the introduction. This is the format of "Introduction" section base on the README.md template.
# Administration Menu
The Administration Menu module displays the entire administrative menu tree
(and most local tasks) in a drop-down menu, providing administrators one- or
two-click access to most pages.
For a full description of the module, visit the
[project page](https://www.drupal.org/project/admin_menu).
Submit bug reports and feature suggestions, or track changes in the
[issue queue](https://www.drupal.org/project/issues/admin_menu).
Thanks.
Hi silvi.addweb
I reviewed your changes and it fixed the comment #14. The README.md file is now following the README.md template. https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or-distribution-project/documenting-your-project/readmemd-template →
Thanks.
Hi kalpanajaiswal
I reviewed your MR!6 and it's missing a link to the project page and issue queue, requirements section is wrong it should be This module requires no modules outside of Drupal core.
since migrate module is a Drupal core, and text should be wrapped within around 80 cols.
Thanks
Hi silvi.addweb
I reviewed the MR!1 and it seems the TOC isn't following README.md template.
This should be the format of TOC as per README.md template:
## Table of contents
- Requirements
- Recommended modules
- Installation
- Configuration
- Troubleshooting
- FAQ
- Maintainers
Thanks
I was able to fix the generated metatag action issue.
Please review.
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.
kenyoOwen → created an issue.
Hi silvi.addweb
I reviewed your changes, it fixed comment #9, and the README file 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