Update README.txt to README.md

Follow the pattern in the README.md template.

CommentFileSizeAuthor
#3 3329756-update-readme-txt-2.patch3.37 KBanoopsingh92
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

anoopsingh92 created an issue. See original summary.

anoopsingh92’s picture

Assigned: anoopsingh92 » Unassigned
Status: Active » Needs review

Please review the patch.

anoopsingh92’s picture

StatusFileSize
new3.37 KB
ressa’s picture

Issue summary: View changes
Status: Needs review » Needs work

Thanks, please follow the pattern under "README format" in the README.md template.

Please create an issue fork (click "Create issue fork") and commit to that, for easier preview.

anoopsingh92’s picture

Status: Needs work » Needs review

Changes are committed You can preview them now.

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

lucienchalom’s picture

I reviewed and fixed the missing newline at the end of the file and a couple of misspelling.
hope is okay now =)

ressa’s picture

Status: Needs review » Needs work

Thanks to both of you! I still see issues, such as:

  • Missing module name
  • A capitalized header
  • Code not marked up as code

Please refer to these lists for required sections and formatting:

lucienchalom’s picture

Status: Needs work » Needs review

Thank you for the review!
I am not sure about marking as a code, so I used markdown reference.

ressa’s picture

Status: Needs review » Needs work

Thanks @lucienchalom, that was what I meant, so that was perfect. Still a few details in the list ...

lucienchalom’s picture

Status: Needs work » Needs review

Fixed the list! =)
I havent found any leading spaces tho.... sorry

ressa’s picture

Status: Needs review » Needs work

They're in the list :)

 - Introduction
 - Requirements
 - Installation
 - Configuration
 - Maintainers

Should be:

- Introduction
- Requirements
- Installation
- Configuration
- Maintainers
lucienchalom’s picture

Status: Needs work » Needs review

=O
I looked at the end of the line only, sorry.
also, i found in the https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or...
that the numbered list uses like this

## Configuration

1. Enable the module at Administration > Extend.
1. When creating a new field on a content type or custom entity type, choose
   "Double Field" from the drop-down menu.
1. On the Field Settings form for the Double Field, define the two subfields
   as you would with any other field.

Should i change that too?

ressa’s picture

Status: Needs review » Needs work

No problem, it was easily over-looked, since it was only a single space character :)

Yes please, about using just 1.'s in the ordered list. It makes them easier create and update.

lucienchalom’s picture

Status: Needs work » Needs review

Awesome!
fixed the numbered list then. =)

ressa’s picture

Status: Needs review » Reviewed & tested by the community

Looks great, thanks @anoopsingh92 and @lucienchalom!

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

rajeshreeputra’s picture

Status: Reviewed & tested by the community » Fixed

Thank you for working on this, merged, release will follow shortly.

Status: Fixed » Closed (fixed)

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