backdrop-contrib / date_all_day

GNU General Public License v2.0
2 stars 2 forks source link

Clean up README.md file #2

Closed jenlampton closed 7 years ago

jenlampton commented 9 years ago

The README.md file for this project is not properly formatted. Sometimes this can happen when projects are ported over from Drupal, since there wasn't a lot of direction on formatting of Drupal's README.txt files.

Please refer to our contributor guidelines for an example README.md file that you can copy. The main problem is the HTML formatting, that should be removed. Markdown files (ending in .md) have their own formatting similar to what we use here on GitHub :)

It is especially important to keep the readme files clean for Backdrop projects because that is what is used for the project page on backdropcms.org. Take a look at the page for this project to see the problem: https://backdropcms.org/project/date_all_day

Graham-72 commented 7 years ago

I think this was fixed some time ago. It seems OK in the latest release.