haskell / haskell/cabal

`cabal check` should warn when readme and other dev docs file exist in the working tree, but are not included in `extra-doc-files`

Open
#10,802 0 comments 1 reaction 0 assignees View on GitHub
cabal-install: cmd/check type: enhancement
Dominant language
Haskell
Stars
1.7k
Forks
750
Avg merge
4d 3h
Merged PRs (30d)
28

Description

Offspring of #3964.

**Describe the feature request**
Browsing Hackage or flora.pm would be a much nicer experience if everyone added their devel docs to `extra-doc-files`.
Sometimes this is not the case, because people forget or because they choose not to (as rendering on Hackage might be off).

It would be nice if `cabal check` looked for all such files in the working tree and hinted the author to add them.
As now `cabal check` warns about *changelogs* but not other files (e.g. `README`s).

The check would have to be granular, so users can `--ignore` specific warnings.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.