https://pareview.sh/ identified some missing README.txt sections:

Your README.txt does not follow best practices (headings need to be uppercase). See https://www.drupal.org/node/2181737 .

The REQUIREMENTS section is missing.
The CONFIGURATION section is missing.

CommentFileSizeAuthor
#12 password_policy-7.x-2.x-add_missing_readme_sections-2954317-12.patch2.31 KBaohrvetpv
#11 interdiff-2954317-10-11.txt396 bytesaohrvetpv
#11 password_policy-7.x-2.x-add_missing_readme_sections-2954317-11.patch2.32 KBaohrvetpv
#10 password_policy-7.x-2.x-add_missing_readme_sections-2954317-10.patch2.31 KBaohrvetpv
#8 password_policy-7.x-2.x-add_missing_readme_sections-2954317-8.patch1015 bytesaohrvetpv
#4 password_policy-7.x-1.x-add_missing_readme_sections-2954317-4.patch946 bytesaohrvetpv
#2 password_policy-7.x-1.x-add_missing_readme_sections-2954317-2.patch946 bytesaohrvetpv

Comments

AohRveTPV created an issue. See original summary.

aohrvetpv’s picture

aohrvetpv commented
Status: Active » Needs review
StatusFileSize
new password_policy-7.x-1.x-add_missing_readme_sections-2954317-2.patch946 bytes

Adding patch to add minimal REQUIREMENTS and CONFIGURATION sections (the two missing required sections).

aohrvetpv’s picture

aohrvetpv commented

Also applies to 7.x-2.x-dev.

aohrvetpv’s picture

aohrvetpv commented
StatusFileSize
new password_policy-7.x-1.x-add_missing_readme_sections-2954317-4.patch946 bytes

The last patch had some unknown character issues.

  • AohRveTPV committed 00ae431 on 7.x-1.x 
    Issue #2954317 by AohRveTPV: Missing required README.txt sections
aohrvetpv’s picture

aohrvetpv commented
Version: 7.x-1.x-dev » 7.x-2.x-dev
aohrvetpv’s picture

aohrvetpv commented
Assigned: Unassigned » aohrvetpv
aohrvetpv’s picture

aohrvetpv commented
StatusFileSize
new password_policy-7.x-2.x-add_missing_readme_sections-2954317-8.patch1015 bytes

Initial work on 7.x-2.x README.txt. I plan to complete the remaining required sections.

riddhi.addweb’s picture

riddhi.addweb commented
Status: Needs review » Needs work

@AohRveTPV, Thanks for your patch, but can you please make it as per the standard so that it can be perfect for the module.
FYI. You can use https://www.drupal.org/docs/develop/documenting-your-project/readme-temp... link.

aohrvetpv’s picture

aohrvetpv commented
Status: Needs work » Needs review
StatusFileSize
new password_policy-7.x-2.x-add_missing_readme_sections-2954317-10.patch2.31 KB

Thank you for reviewing #8, riddhi.addweb. This patch should provide all the required sections and should follow the README template.

aohrvetpv’s picture

aohrvetpv commented
StatusFileSize
new password_policy-7.x-2.x-add_missing_readme_sections-2954317-11.patch2.32 KB
new interdiff-2954317-10-11.txt396 bytes

Forgot the "People" part of the path in the last README.

aohrvetpv’s picture

aohrvetpv commented
StatusFileSize
new password_policy-7.x-2.x-add_missing_readme_sections-2954317-12.patch2.31 KB

Made some wording within CONFIGURATION section more consistent.

  • AohRveTPV committed f5ebbdd on 7.x-2.x 
    Issue #2954317 by AohRveTPV: Missing required README.txt sections
aohrvetpv’s picture

aohrvetpv commented
Version: 7.x-2.x-dev » 8.x-3.x-dev
Status: Needs review » Active

8.x-3.x does not have the required README sections (per README template linked in the issue summary).

aohrvetpv’s picture

aohrvetpv commented
Status: Active » Fixed

Actually the README template pertains to README.txt files, and Password Policy uses a README.md, so I don't know that any of those requirements apply.

It says at https://www.drupal.org/node/2181737:

However, we prefer new projects to use the format described on this page, or a format recognized by the Markdown filter module.

Status: Fixed » Closed (fixed)

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