The Date Popup module is missing a README, which serves as documentation.

Created on 13 September 2024, 3 months ago
Updated 18 September 2024, 3 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

Needs review

Version

2.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 !13Add README.md โ†’ (Open) created by Unnamed author
  • Status changed to Needs review 3 months ago
  • ๐Ÿ‡ต๐Ÿ‡ญPhilippines gslente

    Added a merge request to add a README.md to Date Popup.
    Kindly review.

  • Pipeline finished with Success
    3 months ago
    Total: 348s
    #285940
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia anishnirmal

    @gslente Thank you for adding the README.md file. However, there seems to be a typo in the filename. It is currently named READE.md instead of README.md. Please rename it accordingly.

  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia rushiraval

    rushikesh raval โ†’ made their first commit to this issueโ€™s fork.

  • Pipeline finished with Success
    3 months ago
    Total: 148s
    #293250
  • ๐Ÿ‡ต๐Ÿ‡ญPhilippines cleavinjosh

    Hi,

    Thank you for providing an MR. I applied MR!13, it was applied smoothly and provided a README.md file.

    Just a few things to change. According to the README.md template โ†’ ,

    1. Two lines prior to ##/### headings, in the current, there are one.
    2. In the table of contents, I think "-" is better than the numbered list
    3. Ordered lists use "1", in the current, it is incrementing

    Please check and advise since I am still new to Drupal.
    Thank you.

  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia rushiraval

    Updated as per comment #7

  • Pipeline finished with Success
    3 months ago
    Total: 176s
    #293852
  • ๐Ÿ‡ต๐Ÿ‡ญPhilippines cleavinjosh

    Hi @rushikesh raval,

    Thank you for updating the MR. I applied MR!13, it was applied smoothly and the changes were reflected.

    โžœ  date_popup git:(2.0.2) curl https://git.drupalcode.org/project/date_popup/-/merge_requests/13.diff | patch -p1
      % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                     Dload  Upload   Total   Spent    Left  Speed
    100   956    0   956    0     0   2146      0 --:--:-- --:--:-- --:--:--  2148
    patching file README.md
    โžœ  date_popup git:(2.0.2) โœ—

    Just some clarification, in the Installation section, is that supposed to be an ordered list? My understanding is that those two are steps.

    If it is indeed an ordered list, then kindly use the "1" instead of the "-", please see README.md template โ†’ .

    Otherwise, this is good to go for the maintainers to review.

    Moving the status to Needs work for the meantime.
    Thank you.

  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia rushiraval

    @cleavinjosh Thanks for your review. Please check README.md template โ†’ . There is no firm rules for ordered list / unordered list.

  • You could try something like this:
    # Date Popup

    ## Introduction

    The **Date Popup** module enhances all date fields in views filters by adding the native HTML5 date picker widget, making it easier to select and filter dates with an intuitive popup interface.

    ## Table of Contents

    1. [Requirements](#requirements)
    2. [Installation](#installation)
    3. [Configuration](#configuration)

    ## Requirements

    This module does not require any additional modules outside of Drupal core.

    ## Installation

    To install the **Date Popup** module, follow these steps:

    1. **Using Composer**
    If your Drupal site is managed via Composer, you can install the module by running the following command:
    ```bash
    composer require "drupal/date_popup"

Production build 0.71.5 2024