Problem/Motivation

Replace README.txt with README.md

Steps to reproduce

update the README.md format

Proposed resolution

Follow the pattern in the README.md template.

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

dineshreddymathuku created an issue. See original summary.

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

immaculatexavier’s picture

Status: Active » Needs review

Committed in accordance to the proposed resolution

dineshreddymathuku’s picture

hi #3 thanks for your responce

Manoj Raj.R made their first commit to this issue’s fork.

Manoj Raj.R’s picture

Update with Maintainers section.
Please review it!

Pracheth’s picture

Status: Needs review » Reviewed & tested by the community

Reviewed the README.md (latest MR! by Manoj Raj.R #6 ) , The Markdown looks good to me adhering to Drupal markdown practices.

Changing status to Reviewed and Tested by Community.

ressa’s picture

Issue summary: View changes
Status: Reviewed & tested by the community » Needs work

Thanks, looks good! For perfection and consistency, please also use un-indented dashes in the list "Current maintainers".

Now:
* Peter Vanhee [...]

Update to:
- Peter Vanhee [...]

sourabhjain’s picture

Assigned: Unassigned » sourabhjain

Let me update it.

sourabhjain’s picture

Assigned: sourabhjain » Unassigned
Status: Needs work » Needs review
ressa’s picture

Status: Needs review » Needs work

Thanks! I now see this, which could be formatted into a link:

Now:
Token [http://drupal.org/project/token]

Should be:
[Token](https://drupal.org/project/token)

Manoj Raj.R’s picture

Status: Needs work » Needs review

@ressa
Worked on formatted into a link.

ressa’s picture

Status: Needs review » Needs work

Thanks, but the link is http://drupal.org/project/token, it should be https://drupal.org/project/token

Manoj Raj.R’s picture

Status: Needs work » Needs review

Committed on latest changes

ressa’s picture

Status: Needs review » Reviewed & tested by the community

Thanks @Manoj Raj.R, it looks good now.

dineshreddymathuku’s picture

Hi Manoj Raj.R your changes Looks good for me
Thanks

darvanen’s picture

Status: Reviewed & tested by the community » Needs work

The readme template linked in the issue summary requires two lines prior to a heading.

The only added section was an optional one ("Maintainers"). I don't mind if this issue includes adding sections to the readme but if it does, please include all of the required sections. Please leave the maintainers section off the readme, I do not wish us to have to make code updates to the readme when new maintainers are added to the project, this information is freely available on drupal.org.

Manoj Raj.R’s picture

Status: Needs work » Needs review

Updated as required of Readme format.

please review.

darvanen’s picture

Status: Needs review » Fixed

Thanks everyone for the contribution, this has been merged.

ressa’s picture

Thanks @darvanen. Maybe the default branch on Gitlab can be updated to 2.x, or the 2.x README.md pushed to 1.x?

darvanen’s picture

Good plan @ressa, I'll do that once I've got higher maintainer permissions :)

#3334330: Request for higher maintainer permissions for @darvanen on Token Filter module

ressa’s picture

Awesome! I hope @pvhee or the core team can give you the Maintainer role. Also, perhaps the "Documentation for Token Filter 8.x" link under "Resources" on the project page could lose the "8.x" to be just "Documentation for Token Filter" after the new versioning?

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.