Hi team,

I add README.md file for this module since this is required for security advisory coverage process: https://www.drupal.org/node/539608
https://www.drupal.org/node/1587704

CommentFileSizeAuthor
#10 features-Add-readme-file-2877905-10.patch5.25 KBsakural
#7 features-Add-readme-file-2877905-7.patch4.93 KBsakural
#5 features-Add-readme-file-2877905-5.patch4.87 KBsakural
#2 features-Add-readme-file-2877905-2.patch4.5 KBsakural

Issue fork features-2877905

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:

About issue forks

Comments

sakural created an issue. See original summary.

sakural’s picture

sakural commented
StatusFileSize
new features-Add-readme-file-2877905-2.patch4.5 KB

I just create a simple readme file, if somebody have more about this module, please help me to perfect and check this file .

Many thanks!

sakural’s picture

sakural commented
Status: Active » Needs review
riddhi.addweb’s picture

riddhi.addweb commented
Status: Needs review » Needs work

Thanks Sakural for patch, I have checked your readme file and seems some of the standard are not followed. Please refer this page.

sakural’s picture

sakural commented
Status: Needs work » Needs review
StatusFileSize
new features-Add-readme-file-2877905-5.patch4.87 KB

@jigar.addweeb

Thank you for taking time to review this, refer to your advise, i have made some changes on my fatch, if there still have problems, please tell me.

It's my first time to do this, so sorry for taking your time again.

Thanks!

riddhi.addweb’s picture

riddhi.addweb commented
Status: Needs review » Needs work

Thanks sakural for solving issue, two issues are still there which is given below.

1) Two lines prior to headings (except the first one)
i.e. Before starting of installation headings give two lines gap, currently it is just one line.

2) After "Current state of Features for Drupal 8” headings one line space is missing.

sakural’s picture

sakural commented
Status: Needs work » Needs review
StatusFileSize
new features-Add-readme-file-2877905-7.patch4.93 KB

@Jigar.addweb

Thank you so much for your reply and point out my errors so detailed,

it will save me lot of time to find it out. And i change it again, i'm so sorry to take your time again and again. @_@

Thanks, Good man!

sakural’s picture

sakural commented
riddhi.addweb’s picture

riddhi.addweb commented

Thanks Sakural, I appreciate that, here's some more issues which I forgot to mention in previous comment:

1) All headings should display in capital.
2) Numbered lists intended 4 spaces.
3) Text manually word-wrapped within around 80 cols.
4) Contents of this file section’s Requirements and configuration title should not all caps.
5) Use breadcrumbs in place of path.

sakural’s picture

sakural commented
StatusFileSize
new features-Add-readme-file-2877905-10.patch5.25 KB

Oh my god

It's so stupid that i make the all mistakes i can make, /(ㄒoㄒ)/

So i read the 'readme-template' again from the beginning to the end. And i find some important things

in the end of the page which i ignored before. I'm so luckly to meet you and you help me a lot.

And i make some changes to the patch according to your advises. In the end i want to know if 'Use breadcrumbs in place of path.' is

required for readme file, i can't find some examples in the readme tpl but i change it this time.

Thanks!

riddhi.addweb’s picture

riddhi.addweb commented
Status: Needs review » Reviewed & tested by the community

Thanks for quick fix sakural, I have applied your latest patch and now all issues that i mention in comments are solved.
Good job!

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

dineshreddymathuku opened merge request !21

dineshreddymathuku opened merge request !22

dineshreddymathuku’s picture

dineshreddymathuku commented
Status: Reviewed & tested by the community » Needs review
urvashi_vora’s picture

urvashi_vora commented
Status: Needs review » Needs work

Hi @dinesh,

The merge request can not be merged because it is attempting to fast-forward merge and for that, we need to rebase it locally.

Merge blocked: fast-forward merge is not possible. To merge this request, first rebase locally.

Please try to rebase.

Thanks