haskell / haskell/pvp

Versioning policy for Internal modules

Open
#8 1 comment 0 reactions 0 assignees View on GitHub
enhancement Specification
Dominant language
CSS
Stars
40
Forks
24
PR merge metrics
No merged PRs in 30d

Description

It's been a common practice in the Haskell community to put internal functions to `Internal` modules, which are not meant for a public API but for a semi-private API that can be useful to access library internals to extend the API. I think it's natural to relax the versioning policy for changes in those `Internal` modules. Should we mention it somehow in the PVP?

Contributor guide

Open the contributing guide

Research direction

Start by reading the current PVP specification and the existing comment on this issue. Determine how changes to Internal modules are currently covered and what policy wording would need to change. Done means the policy decision is resolved and the relevant specification text clearly documents the treatment of Internal modules.

Written by the indexing model from the issue text.

Assessment

Tech stack
haskell
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.