haskell / haskell/hackage-server

Improve rendering of `license-files:`

Open
#783 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Haskell
Stars
467
Forks
225
PR merge metrics
No merged PRs in 30d

Description

Currently, the `license-files:` property rendering has taken the cheap way out, by adding a link to the src folder, e.g.

BSD-3-Clause[multiple license files]

but that's clearly suboptimal, as you have no indication which of the files in the source-tree had been listed in the `license-files:` property;

Instead we should implement a proper view of `license-files` that

1. Shows the `license:`-value
2. A small TOC enumerating all referenced license texts in `license-files:` with anchor-links
3. Concatenate each referecned license text (with anchor headings the TOC in 2. links to)

If `license-files:` refers only to a single file, treat it as if it was a plain `license-file:`

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.