Contrib.social

The Typed Entity module is missing a README, which serves as documentation.

Open on Drupal.org →
Created on 20 June 2024, 6 months ago
Updated 29 August 2024, 4 months ago

Problem/Motivation

I observed that the Typed Entity 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

Active

Version

4.0

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.

Sign in to follow issues

Merge Requests

Comments & Activities

  • Issue created by @anishnirmal
  • First commit to issue fork.
  • Merge request !17Issue #3455867 : Added README.md → (Open) created by nfabing
  • Pipeline finished with Failed
    4 months ago
    Total: 82s
    #268255
  • Status changed to Needs review 4 months ago
  • Comment 4 months ago →
    🇫🇷France nfabing
  • Status changed to Needs work 3 months ago
  • Comment 3 months ago →
    🇵🇭Philippines kenyoOwen

    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

  • Assigned to koustav_mondal
  • Comment 1 day ago →
    🇮🇳India koustav_mondal Kolkata

    Working on it.

  • Pipeline finished with Failed
    about 23 hours ago
    Total: 143s
    #372317
  • Comment about 23 hours ago →
    🇮🇳India koustav_mondal Kolkata

    @kenyoowen I made the required changes. Have a look.

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024