Problem/Motivation

README.txt file headings vertical spacing is not as per recommended template at https://www.drupal.org/docs/develop/documenting-your-project/readme-template, the template recommends

Two lines prior to headings (except the first one).

This is violated at few headings.

Proposed resolution

Fix the heading spacing as per recommended templated

Remaining tasks

Verify it
fix it
review it
Commit it

User interface changes

None

API changes

None

Data model changes

None

Release notes snippet

None

Original report by [username]

None

CommentFileSizeAuthor
#18 interdiff-3143115-10-18.txt1.17 KBmrinalini9
#18 README-txt-file-format-for-Drupal-3143115-18.patch1.63 KBmrinalini9
#6 readme-text-scaffold-files-3143115-6.patch2.09 KBramya balasubramanian
#10 README-txt-file-format-for-Drupal-3143115-10.patch2.55 KBramya balasubramanian
#2 readme-format-fix-3143115-1.patch1.21 KBatul4drupal

Comments

atul4drupal created an issue. See original summary.

atul4drupal’s picture

atul4drupal commented
Issue summary: View changes
Status: Active » Needs review
StatusFileSize
new readme-format-fix-3143115-1.patch1.21 KB
atul4drupal’s picture

atul4drupal commented
Assigned: atul4drupal » Unassigned

Status: Needs review » Needs work

The last submitted patch, 2: readme-format-fix-3143115-1.patch, failed testing. View results

ramya balasubramanian’s picture

ramya balasubramanian commented
Assigned: Unassigned » ramya balasubramanian
ramya balasubramanian’s picture

ramya balasubramanian commented
Status: Needs work » Needs review
StatusFileSize
new readme-text-scaffold-files-3143115-6.patch2.09 KB

Hi @atul4drupal,
In this patch, I have added the changes in scaffold files by seeing the test case failure changes. Please have a look and let me know if there are any issues.

ramya balasubramanian’s picture

ramya balasubramanian commented
Assigned: ramya balasubramanian » Unassigned

Status: Needs review » Needs work

The last submitted patch, 6: readme-text-scaffold-files-3143115-6.patch, failed testing. View results

ramya balasubramanian’s picture

ramya balasubramanian commented
Assigned: Unassigned » ramya balasubramanian
ramya balasubramanian’s picture

ramya balasubramanian commented
Status: Needs work » Needs review
StatusFileSize
new README-txt-file-format-for-Drupal-3143115-10.patch2.55 KB

Hi @atul4drupal,
Added the patch again.

Webbeh’s picture

Webbeh
he/him/his
Location Georgia, USA
commented
Assigned: ramya balasubramanian » Unassigned
sivaji_ganesh_jojodae’s picture

sivaji_ganesh_jojodae commented
Issue tags: +Novice

Looks good to me.

On a related note, readme has links specific to Drupal 8.

Drupal's appearance:
@@ -89,6 +91,7 @@ More about themes:
* Develop your own theme:
https://www.drupal.org/docs/8/theming

atul4drupal’s picture

atul4drupal commented
Status: Needs review » Reviewed & tested by the community

Regarding #10: Thanks Ramya Balasubramanian for taking this forward. Patch at #10 looks good to fix the file format as per recommended template.

Regarding #12:
Thanks for taking time to review the patch and sharing valuable feedback.

The theming reference link certainly looks to be D8 specific, thought it redirects to a version neutral page at "https://www.drupal.org/docs/theming-drupal" we may have that updated but I think it will be a scope creep for this issue. We may have separate issue created to ensure all links in README are correct and point to latest resource.

xjm’s picture

xjm
she/her
Primary language English
commented

Almost NWed this because a failing patch was at the top of the summary. Fixing that.

xjm’s picture

xjm
she/her
Primary language English
commented
xjm’s picture

xjm
she/her
Primary language English
commented
Status: Reviewed & tested by the community » Needs work

Thanks for working on this formatting.

+++ b/README.txt
@@ -80,8 +82,8 @@ APPEARANCE
-themes. More themes are available for download, and you can also create your own
-custom theme.
+themes. More themes are available for download, and you can also create your
+own custom theme.

+++ b/core/assets/scaffold/files/drupal.README.txt
@@ -80,8 +82,8 @@ APPEARANCE
-themes. More themes are available for download, and you can also create your own
-custom theme.
+themes. More themes are available for download, and you can also create your
+own custom theme.

This is an out-of-scope change. Before, it was exactly 80 chars. This is rewrapping it needlessly and is also unrelated to the issue scope of "add newlines".

If we can just remove those two changes from the patch I think this is good. Thanks!

mrinalini9’s picture

mrinalini9 commented
Assigned: Unassigned » mrinalini9
mrinalini9’s picture

mrinalini9 commented
Assigned: mrinalini9 » Unassigned
Status: Needs work » Needs review
StatusFileSize
new README-txt-file-format-for-Drupal-3143115-18.patch1.63 KB
new interdiff-3143115-10-18.txt1.17 KB

Hi @xjm, I have updated the patch and removed the changes as mentioned in #16, please review.

atul4drupal’s picture

atul4drupal commented
Status: Needs review » Reviewed & tested by the community

#18: Thanks mrinalini9 for working on this, the patch meets the requirement and the suggestion from #16

#16: Thanks for pointing out the unnecessary change

  • xjm committed 2b29ed1 on 9.1.x 
    Issue #3143115 by Ramya Balasubramanian, mrinalini9, atul4drupal, xjm:...

  • xjm committed 95bc669 on 9.0.x 
    Issue #3143115 by Ramya Balasubramanian, mrinalini9, atul4drupal, xjm:...

  • xjm committed 7fc3465 on 8.9.x 
    Issue #3143115 by Ramya Balasubramanian, mrinalini9, atul4drupal, xjm:...

  • xjm committed d6e4cc1 on 8.8.x 
    Issue #3143115 by Ramya Balasubramanian, mrinalini9, atul4drupal, xjm:...
xjm’s picture

xjm
she/her
Primary language English
commented
Version: 9.1.x-dev » 8.8.x-dev

Thanks everyone. I applied this locally and confirmed there are now blank lines before each header aside from the first one.

Committed to 9.1.x, and backported to 9.0.x, 8.9.x, and 8.8.x as a documentation formatting improvement. Thanks!

atul4drupal’s picture

atul4drupal commented
Status: Reviewed & tested by the community » Fixed

Thanks xjm for committing and back-porting this.
I believe as this is now committed and back-ported, its safe to update the ticket status to fixed. Feel free to update if something I am missing.

Thanks.

Status: Fixed » Closed (fixed)

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