Closed (fixed)
Project:
Flag
Version:
8.x-4.x-dev
Component:
Documentation
Priority:
Normal
Category:
Feature request
Assigned:
Unassigned
Issue tags:
Reporter:
Created:
20 Mar 2017 at 12:18 UTC
Updated:
3 Aug 2020 at 19:39 UTC
Jump to comment: Most recent, Most recent file
Comments
Comment #2
renatog commentedThe patch it's in attachment.
Good Work and Good Week.
Regards.
Comment #3
krina.addweb commented@renatog, thanks for the patch it works well & following are the issues which were founded from Readme patch.
1)
Change Administer -> Modules (/admin/modules) to Administration -> Modules
2)
Change Administer -> Structure -> Flags (/admin/modules) to Administration -> Structure -> Flags
3) Current maintainers: Add "https://www.drupal.org/u/fago" fago as maintainer
Comment #4
dhruveshdtripathi commentedThank you @krina.addweb for suggesting changes. Working on it.
Comment #5
dhruveshdtripathi commentedMade changes according to comment #3. Removed whitespace which was giving a warning while applying the last patch.
Comment #6
dhruveshdtripathi commentedComment #7
renatog commentedThank you @krinaaddweb for your review and @dhruveshdtripathi for your contribution.
Works Good for me. +RTBC
Regards.
Comment #8
joachim commentedThanks everyone for working on this! (And thanks for making me aware of the README standard -- I wasn't aware of it.)
However, work should be done on the 8.x-4.x branch first and then backported.
Also, a few small nitpicks:
These lines can be removed, per the README Template docs.
This should go under requirements, surely?
The docs don't mention the need for this, so let's remove it. d.org adds the licence file anyway.
Comment #9
dhruveshdtripathi commentedWorking on it
Comment #10
dhruveshdtripathi commentedCreated a patch for 8.x-4.x branch. Made few changes according to standards.
Comment #11
joachim commentedLooking good, thanks!
The section on installation still needs to be changed to the standard form suggested in the template.
Comment #12
dhruveshdtripathi commentedYes, installation section still needs to be changed to the standard form. Working on it.
Thanks!
Comment #13
dhruveshdtripathi commentedMade changes in INSTALLATION section according to template.
Following points are taken care in the patch:
- Bullets denoted by asterisks (*) with hanging indents.
- Numbered lists indented 4 spaces.
Thank you!
Comment #14
joachim commented> Made changes in INSTALLATION section according to template.
That change seems to have been missed off.
The template has this:
The latest patch still has more detail than is needed.
Comment #15
neel24 commentedOk so I've created a new patch which applies the readme, following the readme template: https://www.drupal.org/docs/develop/documenting-your-project/readme-temp...
Comment #16
neerajpandey commented#15 looks fine. It just needs some spacing edits and support request section. Adding a patch and interdiff for the same.
Comment #17
alonaoneill commentedAdd "To submit bug reports and feature suggestions, or to track changes" part here
Make it numbered list?
I would remove those empty lines
Comment #18
neel24 commentedAlright, so I've created a new patch based on the one in #16 and applied the changes mentioned in #17. I've also attached an interdiff.
Comment #19
alonaoneill commentedReviewed the patch for spelling and grammar. Formatting aligns to Drupal documentation standards. Everything looks good. Patch applied.
Marking as RTBCed.
Thank you for working on the module!
Comment #20
berdirAdded myself as a maintainer and committed.