haskell / haskell/pvp

FAQ should mention x-uncurated

Open
#29 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
CSS
Stars
40
Forks
24
PR merge metrics
No merged PRs in 30d

Description

According to http://hackage.haskell.org/upload

"Packages which are uncurated have no expectations on them regarding versioning policy."

Yet the PVP FAQ says

"Yes, packages uploaded to Hackage (which is a pre-requisite for being included in Stackage) are expected to honor the PVP."

Since only curated packages must honor the PVP, the PVP FAQ is inaccurate. I suggest editing the "My package is in Stackage" answer - perhaps something like "The PVP requires that you specify all version bounds. If you do not wish to adhere to this aspect of the PVP, your package is not PVP compliant and you must indicate this by setting the x-curation field in your .cabal file to uncurated."

Contributor guide

Open the contributing guide

Research direction

Locate the PVP FAQ and its answer about packages in Stackage, then compare it with the quoted Hackage guidance in the issue. Update the answer so it accurately explains the x-curation setting for uncurated packages, and verify that the FAQ clearly distinguishes curated packages from packages that do not follow the PVP.

Written by the indexing model from the issue text.

Assessment

Tech stack
haskell
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.