The Migrate Scanner module is missing a README, which serves as documentation.

Created on 20 June 2024, 5 months ago

Updated 28 June 2024, 5 months ago

Problem/Motivation

I observed that the Migrate Scanner Module repository is deficient in a README file. It is essential to have a README that includes module usage, description, valuable links and configuration details. Adhering to Drupal standards, modules should incorporate a comprehensive README file for proper documentation.

For more guidance on creating module documentation, you can refer to the following link: https://www.drupal.org/docs/develop/documenting-your-project/module-documentation-guidelines →

Proposed resolution

Please provide a README file that adheres to the template outlined in the following document: https://www.drupal.org/docs/develop/documenting-your-project/readme-template →

📌 Task

Status

Needs work

Version

1.1

Component

Documentation

Created by

🇮🇳India anishnirmal

Live updates comments and jobs are added and updated live.

Needs documentation
A documentation change is requested elsewhere. For Drupal core (and possibly other projects), once the change has been committed, this status should be recorded in a change record node.

Novice
It would make a good project for someone who is new to the Drupal contribution process. It's preferred over Newbie.

Add README.md file

Readme file

Merge Requests

!6The Migrate Scanner module is missing a README, which serves as documentation.
Open
🇮🇳India kalpanajaiswal
updated 5 months ago

Comments & Activities

Issue created by @anishnirmal
First commit to issue fork.
Merge request !6Update file README.md → (Open) created by kalpanajaiswal
Open in Jenkins → Open on Drupal.org →
Core: 10.2.1 + Environment: PHP 8.0 & MySQL 5.7
last update 5 months ago
Unable to generate test groups
Comment 5 months ago →
🇮🇳India kalpanajaiswal
README.md file has been created and ready for review.
Status changed to Needs review 5 months ago4:14am 25 June 2024
Comment 5 months ago →
🇮🇳India kalpanajaiswal
Status changed to Needs work 5 months ago7:08am 28 June 2024
Comment 5 months ago →
🇵🇭Philippines kenyoOwen
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

contrib.social Blog FAQ Discussions

Production build 0.71.5 2024

The Migrate Scanner module is missing a README, which serves as documentation.

Problem/Motivation

Proposed resolution

Merge Requests

!6The Migrate Scanner module is missing a README, which serves as documentation.Open

Comments & Activities

!6The Migrate Scanner module is missing a README, which serves as documentation.
Open