Update library to Contributors library standards

purescript-contrib / purescript-matryoshka

Generalized folds, unfolds, and traversals for fixed point data structures

Apache License 2.0

59 stars 13 forks source link

Update library to Contributors library standards #15

Closed maxdeviant closed 3 years ago

maxdeviant commented 3 years ago

This PR updates purescript-matryoshka to adhere to the Contributors library guidelines.

This is part of the https://github.com/purescript-contrib/governance/issues/13 effort.

maxdeviant commented 3 years ago

Verified that the build works and the "tests" run:

λ spago build
[info] Installation complete.
[info] Build succeeded.

λ spago test
[info] Installation complete.
[info] Build succeeded.
expr example
24
list example
24
4 : 3 : 2 : 1 : Nil
720
[info] Tests succeeded.

Once this PR gets merged I'll add issues for the following outstanding items:

Adding a "quick start" guide
Adding real tests (currently they're just runnable examples)
Adding module documentation

maxdeviant commented 3 years ago

Once this PR gets merged I'll add issues for the following outstanding items:

Adding a "quick start" guide

Adding real tests (currently they're just runnable examples)

Adding module documentation

I went ahead and created these issues now, since I forgot to do it once https://github.com/purescript-contrib/purescript-arraybuffer-types/pull/16 was merged :man_facepalming:

thomashoneyman commented 3 years ago

Couple of minor comments, but otherwise 👍