Skip to content

Commit 3acb0e8

Browse files
committed
Put new README & CONTRIBUTING file in place
1 parent 546883d commit 3acb0e8

File tree

2 files changed

+26
-0
lines changed

2 files changed

+26
-0
lines changed

Diff for: CONTRIBUTING

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
For simple typos and obvious clarifications go ahead and submit a PR.
2+
3+
For more substantial changes, here's some ideas how to articulate your RFC/proposal:
4+
5+
- try to review previous proposals in case similiar ideas were already proposed
6+
- state clearly what problem your proposal is trying to address
7+
- if you file an issue rather than a concrete PR, state precisely what you intend to change
8+
- describe how your change helps addressing the problem
9+
- describe any disadvantages/trade-offs of the proposal you are aware of
10+
- describe implications for backward compatibility or changes to Cabal needed

Diff for: README.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Haskell Package Version Policy (PVP) Specification
2+
3+
This repository is the home of the specification of [Haskell's PVP](http://pvp.haskell.org/) which together
4+
with the [*Common Architecture for Building Applications and Tools* (CABAL)](https://www.haskell.org/cabal/proposal/pkg-spec.pdf)
5+
specification provides the foundational framework powering [Hackage](http://hackage.haskell.org),
6+
Haskell's central package repository.
7+
8+
## Proposing Changes
9+
10+
The PVP evolves over time to adapt to changing requirements of the community.
11+
Everyone is invited to propose and discuss changes to the policy.
12+
13+
Formally, the PVP is maintained by the [Core Libraries Committee](https://wiki.haskell.org/Core_Libraries_Committee)
14+
together with the [Hackage Trustees](https://github.com/haskell-infra/hackage-trustees).
15+
16+
Please review the [guidelines for contributing](CONTRIBUTING).

0 commit comments

Comments
 (0)