haskell / haskell/cabal

Clarify `maintainer` field (documentation, semantics)

Open
#7,285 0 comments 1 reaction 0 assignees View on GitHub
Cabal: file format documentation
Dominant language
Haskell
Stars
1.7k
Forks
750
Avg merge
4d 3h
Merged PRs (30d)
28

Description

https://cabal.readthedocs.io/en/3.4/cabal-package.html#pkg-field-maintainer says:
> maintainer: address
>
> The current maintainer or maintainers of the package. This is an e-mail address to which users should send bug reports, feature requests and patches.

Issues:
- "maintainers" (plural) and "an e-mail address" (singular) are in slight conflict with each other
- __one__ email address often does not accommodates __several__ maintainers
- the content of this field is de facto not rendered as an email address on hackage
- the idea that people send patches via email has fallen a bit out of time

Suggestions:
- change the field type to _freeform_
- change the text to:

> The current maintainer or maintainers of the package. May contain e-mail addresses which can be used to communicate with the maintainer(s).

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.