Support for Drupal 7 is ending on 5 January 2025—it’s time to migrate to Drupal 10! Learn about the many benefits of Drupal 10 and find migration tools in our resource center.
README.txt does not follow best practices
The INTRODUCTION section is missing.
The REQUIREMENTS section is missing.
The INSTALLATION section is missing.
The CONFIGURATION section is missing.
Comment | File | Size | Author |
---|---|---|---|
#4 | 3119628-4.patch | 6.94 KB | Webbeh |
Comments
Comment #2
ridhimaabrol24 CreditAttribution: ridhimaabrol24 at Srijan | A Material+ Company for Drupal India Association commentedComment #3
clemens.tolboomYou could write a patch following https://www.drupal.org/node/707484 or write it in this issue as a comment?
Comment #4
WebbehUntil such time that we have community standards for README.MD files, this is in line with what automated testing identifies. For review.
Comment #5
clemens.tolboom@Webbeh thanks for this patch.
Can you please tell me to learn how I can reproduce this.
Is your patch valid markdown? Esp. the lists concerns me. iirc no space for list except list subitems.
Comment #6
WebbehI believe the automated tests just look for header lines as outlined in #2181737 - two blank lines above, one below - with headers all in caps.
There's a big asterisks with this page as it applies primarily to README.TXT and not exactly .MD files, so I leave that to y'all to determine if these changes are acceptable.
Please feel free to interdiff and apply an extra patch to fix any oddities, as I did not do a thorough Markdown check.
Comment #7
WebbehUn-assigning original issuer, and marking needs work for:
Comment #8
clemens.tolboomhttps://www.drupal.org/docs/develop/documenting-your-project/readme-temp...
Comment #9
WebbehIf you prefer the patch to follow the existing README.txt best-practices, I'm happy to standardize spacing and hard-wraps and submit a new patch, @clemens.tolboom .
Comment #10
clemens.tolboomI don't know how we got this README.md in the first place. Found the README.txt template.
@Webbeh please do so :-)
Comment #11
clemens.tolboomArgh ... further down that page https://www.drupal.org/docs/develop/documenting-your-project/readme-temp... it is OK to have markdown format to.
Let's keep the markdown then. But make it valid markdown :)
Comment #12
clemens.tolboomThe project page text came from #3004326-9: Make the Tour UI project page look awesome ... not sure we need to align texts?
Comment #13
WebbehAs of right now, we don't have a standard Markdown formatting preference. There's work to address this (#2506415: Adopt Markdown for README.txt and other documentation), but it's necessitated by other issues to resolve (#2952616: Adopt CommonMark spec for Markdown files and #3012906: Conflict between coding standards and module documentation guidelines on file naming). Until then, we can assume author preferences until the community reaches a direction/consensus.
Comment #14
smustgrave CreditAttribution: smustgrave at Mobomo commentedWill update in another ticket.
Thanks!