`LICENSE.md` is meant to be plaintext, not markdown.

modrinth / code

The Modrinth monorepo containing all code which powers Modrinth!

https://modrinth.com

Other

921 stars 171 forks source link

`LICENSE.md` is meant to be plaintext, not markdown. #1962

Closed ImperatorStorm closed 1 year ago

ImperatorStorm commented 2 years ago

Environment

No response

Describe the bug

The AGPLv3 is meant to be displayed as plaintext. Having LICENSE be markdown has it run through a markdown processor, breaking formatting.

Steps To Reproduce

No response

Expected behavior

Expected formatting

Current formatting

Additional context

Possibly oversight with https://github.com/modrinth/knossos/commit/4b1b2878eaf0c0ada4a58489a0bb2589b7d9702c that was never noticed or rectified?

NatoBoram commented 2 years ago

To add to OP's comment;

LICENSE.md is supposed to be a markdown file whereas LICENSE or LICENSE.txt is supposed to be a plaintext file. If Modrinth wishes to use a markdown or plaintext license, it would be appropriate to use the correct extension and match it with the correct file format.

The GNU Affero General Public License offers both a plaintext and a markdown file.

Secret-chest commented 2 years ago

a markdown file.

This should be used. It provides better formatting.

triphora commented 1 year ago

Fixed in modrinth/knossos#819