Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify maintainer field (documentation, semantics) #7285

Open
andreasabel opened this issue Feb 20, 2021 · 0 comments
Open

Clarify maintainer field (documentation, semantics) #7285

andreasabel opened this issue Feb 20, 2021 · 0 comments

Comments

@andreasabel
Copy link
Member

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).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants