Problem/Motivation
Replace README.txt with README.md

Steps to reproduce
update the README

Proposed resolution
following this pattern
https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or...

CommentFileSizeAuthor
#20 date_readme.PNG31.83 KBkavitha89

Issue fork date-3318896

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

Comments

gowthami reddy created an issue. See original summary.

gowthami reddy’s picture

Status: Active » Needs review

As per md format the readme file

damienmckenna’s picture

Status: Needs review » Closed (won't fix)

Thank you, but the 8.x-1.x branch is not supported because Drupal core has some (limited) date field support.

Manoj Raj.R’s picture

Can we use it in 7x version to change the Readme txt to Readme md format.

damienmckenna’s picture

Sure.

Manoj Raj.R’s picture

Version: 8.x-1.x-dev » 7.x-3.x-dev
Status: Closed (won't fix) » Active

Manoj Raj.R’s picture

Version: 7.x-3.x-dev » 7.x-2.x-dev

Manoj Raj.R’s picture

Status: Active » Needs review

Recent commit in the branch 3318896-replace-txt.
Please review it.

damienmckenna’s picture

Status: Needs review » Needs work

This needs further work to use the Markdown format properly, e.g. instead of having links in a separate "References" section they should be inline.

Manoj Raj.R’s picture

Status: Needs work » Needs review

Updated the references section with markdown format Links.
Please review it.

WagnerMelo’s picture

Assigned: Unassigned » WagnerMelo

Hi, i'll review it. XD

WagnerMelo’s picture

Assigned: WagnerMelo » Unassigned
Status: Needs review » Reviewed & tested by the community

I reviewed this issue, and the changes maded by @Manoj Raj.R look like ok to me, and attends the patterns asked by @DamienMcKenna at #11.
And i didn't have any problem to apply this patch, so i'll move this issue to RTBC.

damienmckenna’s picture

Status: Reviewed & tested by the community » Needs work

This needs some work to use the Markdown format better, e.g. instead of having a separate "references" section each link should be inline. Also, the bulleted list for the submodules list needs to be reformatted.

shivam_tiwari made their first commit to this issue’s fork.

shivam_tiwari’s picture

Status: Needs work » Needs review
kavitha89’s picture

Status: Needs review » Reviewed & tested by the community
StatusFileSize
new31.83 KB

The patch works fine and moving it to RTBC.

damienmckenna’s picture

Status: Reviewed & tested by the community » Needs work

1. Please don't create a new merge request when the maintainer asks for changes to an existing merge request. Instead, please update the existing merge request with the requested changes.
2. Please don't post screenshots of merge requests applying and saying "works fine", that is a waste of time. Instead, please review the merge request's changes and see if it includes the changes requested by the maintainer.

Setting this back to "needs work" as none of my feedback was considered.

thakurnishant_06 made their first commit to this issue’s fork.

thakurnishant_06’s picture

Status: Needs work » Needs review

Hello @DamienMcKenna,
Hope you are doing well. Updated the Readme.md file as per the README.md template.
Kindly review the changes.
Thank you.

nupur badola’s picture

Status: Needs review » Needs work

Reviewed MR!18, the patch is not cleanly applied.

1. Table of content does not written in correct format as per template. 
it should be written like this: ## Table of contents

- Requirements
- Recommended modules
- Installation
- Configuration
- Troubleshooting
- FAQ
- Maintainers 

ravi kant changed the visibility of the branch 7.x-2.x to hidden.

ravi kant changed the visibility of the branch 3318896-replace-txt to active.

ravi kant changed the visibility of the branch 7.x-2.x to active.

ravi kant changed the visibility of the branch 3318896-replace-txt to hidden.

nitin_lama’s picture

Assigned: Unassigned » nitin_lama
nitin_lama’s picture

Status: Needs work » Needs review
nitin_lama’s picture

Assigned: nitin_lama » Unassigned
nupur badola’s picture

Status: Needs review » Needs work

Reviewed MR!18, the patch is not cleanly applied

Table of content does not written in correct format as per template.
it should be written like this: ## Table of contents

- Requirements
- Recommended modules
- Installation
- Configuration
- Troubleshooting
- FAQ
- Maintainers

bharath-kondeti made their first commit to this issue’s fork.

bharath-kondeti’s picture

Status: Needs work » Needs review
kenyoowen’s picture

Status: Needs review » Needs work

Hi bharath-kondeti

I reviewed your changes in MR!18 and missing the "modules" text in ## Related section. The format for the Related section is wrong it should be
[Calendar](http://drupal.org/project/calendar) so it's easy to visit the Calendar module and other modules that are in the Related section. As per comment #33 Table of contents is not following README.md.

Thank you.

gajanan.wasnik made their first commit to this issue’s fork.

gajanan.wasnik’s picture

Assigned: Unassigned » gajanan.wasnik
Status: Needs work » Needs review
steinmb’s picture

Assigned: gajanan.wasnik » Unassigned
clarkssquared’s picture

Hi

I applied the updated MR !18, and it replaced the README.txt file with README.md with the content below

# Date

The Date module suite provides an API for handling date values, a field for
Drupal 7's Field API system, and a wealth of submodules for various purposes.

For a full description of the module, visit the
[project page](https://www.drupal.org/project/date).

Submit bug reports and feature suggestions, or track changes in the
[issue queue](https://www.drupal.org/project/issues/date).


## Table of contents

- Requirements
- Installation
- Configuration
- Related Modules
- Maintainers


## Requirements

This module requires no modules outside of Drupal core.


## Installation

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).


## Configuration

The module has no menu or modifiable settings. There is no configuration.


## Related modules

This is the beginning of a list of modules that extend Date to solve particular problems.
Please check them out if the core Date functionality isn't sufficient for your needs.

- [Calendar](http://drupal.org/project/calendar)
- [Date iCal](http://drupal.org/project/date_ical)
- [Partial Date](http://drupal.org/project/partial_date)
- [Signup](http://drupal.org/project/signup)
- [CCK Signup](http://drupal.org/project/cck_signup)
- [Registration](http://drupal.org/project/registration)


## Maintainers

- Andrii Podanenko - [podarok](https://www.drupal.org/u/podarok)
- Alex Schedrov - [sanchiz](https://www.drupal.org/u/sanchiz)
- Damien McKenna - [Damien McKenna](https://www.drupal.org/u/damienmckenna)
- Vijaya Chandran Mani - [vijaycs85](https://www.drupal.org/u/vijaycs85)
- Karen Stevenson - [KarenS](https://www.drupal.org/u/karens)
- Arlin Sandbulte - [arlinsandbulte](https://www.drupal.org/u/arlinsandbulte)
- Derek Wright - [dww](https://www.drupal.org/u/dww)
- Gisle Hannemyr - [gisle](https://www.drupal.org/u/gisle)
- Angie Byron - [webchick](https://www.drupal.org/u/webchick)
- David Goode - [David Goode](https://www.drupal.org/user/291318)
- developer-x - [developer-x](https://www.drupal.org/user/399625)
- Peter Lieverdink - [cafuego](https://www.drupal.org/u/cafuego)

RTBC +1 from me