Skip to content

Commit 9d9fbd1

Browse files
Generate changelog and add PR template (#111)
* Generate CHANGELOG.md file using notes from previous GH releases * Add pull request template
1 parent 18a4a73 commit 9d9fbd1

File tree

2 files changed

+252
-0
lines changed

2 files changed

+252
-0
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
**Description of the change**
2+
3+
Clearly and concisely describe the purpose of the pull request. If this PR relates to an existing issue or change proposal, please link to it. Include any other background context that would help reviewers understand the motivation for this PR.
4+
5+
---
6+
7+
**Checklist:**
8+
9+
- [ ] Added the change to the changelog's "Unreleased" section with a reference to this PR (e.g. "- Made a change (#0000)")
10+
- [ ] Linked any existing issues or proposals that this pull request should close
11+
- [ ] Updated or added relevant documentation
12+
- [ ] Added a test for the contribution (if applicable)

CHANGELOG.md

Lines changed: 240 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,240 @@
1+
# Changelog
2+
3+
Notable changes to this project are documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
4+
5+
## [Unreleased]
6+
7+
Breaking changes:
8+
9+
New features:
10+
11+
Bugfixes:
12+
13+
Other improvements:
14+
15+
## [v5.2.0](https://github.com/purescript/purescript-free/releases/tag/v5.2.0) - 2019-04-01
16+
17+
Added `Semigroup` and `Monoid` instances for `Free` (@safareli)
18+
19+
## [v5.1.0](https://github.com/purescript/purescript-free/releases/tag/v5.1.0) - 2018-06-14
20+
21+
Add `MonadFree` and `ComonadCofree` classes.
22+
23+
## [v5.0.0](https://github.com/purescript/purescript-free/releases/tag/v5.0.0) - 2018-05-23
24+
25+
- Updated for PureScript 0.12
26+
- `Trampoline` is now based on `(->) Unit` rather than `Lazy` to avoid unnecessary caching
27+
28+
## [v4.3.0](https://github.com/purescript/purescript-free/releases/tag/v4.3.0) - 2018-04-07
29+
30+
- Added `wrap` for `Free` (@ajnsit)
31+
- Added more instances for `Coyoneda`
32+
33+
## [v4.2.0](https://github.com/purescript/purescript-free/releases/tag/v4.2.0) - 2017-12-11
34+
35+
- Make `Cofree` lazier (@natefaubion)
36+
- Add `buildCofree` and deprecate `unfoldCofree` (@natefaubion)
37+
- Add `deferCofree` (@natefaubion)
38+
39+
## [v4.1.0](https://github.com/purescript/purescript-free/releases/tag/v4.1.0) - 2017-06-23
40+
41+
Add `resume'` (@natefaubion)
42+
43+
## [v4.0.1](https://github.com/purescript/purescript-free/releases/tag/v4.0.1) - 2017-05-28
44+
45+
`Coyoneda` docs (@coot)
46+
47+
## [v4.0.0](https://github.com/purescript/purescript-free/releases/tag/v4.0.0) - 2017-03-27
48+
49+
- Updated for PureScript 0.11
50+
- Added `Eq1` and `Ord1` instances
51+
- Rearrange the arguments of `unfoldCofree` to be more natural
52+
- The `Applicative` instance is now consistent with `Monad`
53+
54+
## [v3.5.1](https://github.com/purescript/purescript-free/releases/tag/v3.5.1) - 2017-03-16
55+
56+
Export `exploreM`.
57+
58+
## [v3.5.0](https://github.com/purescript/purescript-free/releases/tag/v3.5.0) - 2017-03-16
59+
60+
Add `exploreM` (@coot)
61+
62+
## [v3.4.0](https://github.com/purescript/purescript-free/releases/tag/v3.4.0) - 2017-01-31
63+
64+
- Added `unCoyoneda`
65+
66+
## [v3.3.0](https://github.com/purescript/purescript-free/releases/tag/v3.3.0) - 2017-01-02
67+
68+
- Added `Eq` and `Ord` instances for `Free` and `Cofree`
69+
70+
## [v3.2.0](https://github.com/purescript/purescript-free/releases/tag/v3.2.0) - 2016-12-29
71+
72+
- Added `Foldable` and `Traversable` instances for `Free`
73+
74+
## [v3.1.0](https://github.com/purescript/purescript-free/releases/tag/v3.1.0) - 2016-12-24
75+
76+
- Added `explore` combinator for `Cofree` (@paf31)
77+
78+
## [v3.0.1](https://github.com/purescript/purescript-free/releases/tag/v3.0.1) - 2016-11-14
79+
80+
- Fixed shadowed name warnings
81+
82+
## [v3.0.0](https://github.com/purescript/purescript-free/releases/tag/v3.0.0) - 2016-10-16
83+
84+
- Updated catenable-lists dependency
85+
86+
## [v2.0.0](https://github.com/purescript/purescript-free/releases/tag/v2.0.0) - 2016-10-13
87+
88+
- Updated dependencies
89+
- Added `unfoldCofree`
90+
91+
## [v1.4.0](https://github.com/purescript/purescript-free/releases/tag/v1.4.0) - 2016-09-27
92+
93+
- Added `hoistCofree`
94+
95+
## [v1.3.0](https://github.com/purescript/purescript-free/releases/tag/v1.3.0) - 2016-09-14
96+
97+
- Added `(:<)` operator for `Cofree` constructor
98+
99+
## [v1.2.0](https://github.com/purescript/purescript-free/releases/tag/v1.2.0) - 2016-07-28
100+
101+
- Added `substFree` for better performance when folding into another `Free` (@natefaubion)
102+
- Implemented `hoistFree` in terms of `substFree` for better performance (@natefaubion)
103+
104+
## [v1.1.0](https://github.com/purescript/purescript-free/releases/tag/v1.1.0) - 2016-07-26
105+
106+
- Restored a `resume` function (@natefaubion)
107+
- Improved performance of `runFree` (@natefaubion)
108+
109+
## [v1.0.0](https://github.com/purescript/purescript-free/releases/tag/v1.0.0) - 2016-06-01
110+
111+
This release is intended for the PureScript 0.9.1 compiler and newer.
112+
113+
**Note**: The v1.0.0 tag is not meant to indicate the library is “finished”, the core libraries are all being bumped to this for the 0.9 compiler release so as to use semver more correctly.
114+
115+
## [v1.0.0-rc.3](https://github.com/purescript/purescript-free/releases/tag/v1.0.0-rc.3) - 2016-05-26
116+
117+
- Updated for introduction of `Data.NaturalTransformation` to the prelude
118+
- Renamed `mapF` to `hoistFree`
119+
- Renamed `liftCoyonedaT` to `hoistCoyoneda`
120+
- Added `hoistYoneda`
121+
122+
## [v1.0.0-rc.2](https://github.com/purescript/purescript-free/releases/tag/v1.0.0-rc.2) - 2016-05-22
123+
124+
- Relaxed constraints for some instances of `Cofree` and fixed `pure` implementation (@parsonsmatt)
125+
126+
## [v1.0.0-rc.1](https://github.com/purescript/purescript-free/releases/tag/v1.0.0-rc.1) - 2016-03-28
127+
128+
- Release candidate for the psc 0.8+ core libraries
129+
130+
## [v0.9.1](https://github.com/purescript/purescript-free/releases/tag/v0.9.1) - 2015-11-19
131+
132+
- Fixed warnings raised in psc 0.7.6
133+
134+
## [v0.9.0](https://github.com/purescript/purescript-free/releases/tag/v0.9.0) - 2015-09-16
135+
136+
- Bump `transformers` dependency
137+
138+
## [v0.8.0](https://github.com/purescript/purescript-free/releases/tag/v0.8.0) - 2015-08-26
139+
140+
Bump `transformers` to `0.7.1`.
141+
142+
This release requires the 0.7.4.1 release of the PureScript compiler. Previous versions of this library will _not_ work with `psc` versions < 0.7.4.1.
143+
144+
## [v0.7.0](https://github.com/purescript/purescript-free/releases/tag/v0.7.0) - 2015-08-16
145+
146+
- New implementation based on “[Reflection without Remorse](http://okmij.org/ftp/Haskell/zseq.pdf)” (@ethul)
147+
148+
## [v0.6.1](https://github.com/purescript/purescript-free/releases/tag/v0.6.1) - 2015-07-29
149+
150+
- Added `MonadRec` instance (@LiamGoodacre)
151+
152+
## [v0.6.0](https://github.com/purescript/purescript-free/releases/tag/v0.6.0) - 2015-07-24
153+
154+
- Added `injF` and renamed `injC` to `injFC` for consistency with the other `F`/`FC` functions
155+
156+
## [v0.5.1](https://github.com/purescript/purescript-free/releases/tag/v0.5.1) - 2015-07-23
157+
158+
- Added additional function variations `liftFI`, `liftFCI` and `mapFC`
159+
- Added new functions `bindF` and `bindFC`
160+
161+
## [v0.5.0](https://github.com/purescript/purescript-free/releases/tag/v0.5.0) - 2015-06-30
162+
163+
This release works with versions 0.7.\* of the PureScript compiler. It will not work with older versions. If you are using an older version, you should require an older, compatible version of this library.
164+
165+
## [v0.5.0-rc.1](https://github.com/purescript/purescript-free/releases/tag/v0.5.0-rc.1) - 2015-06-07
166+
167+
Initial release candidate of the library intended for the 0.7 compiler.
168+
169+
## [v0.4.2](https://github.com/purescript/purescript-free/releases/tag/v0.4.2) - 2015-05-13
170+
171+
- Update to prevent stack overflow with left-associated binds (@ethul)
172+
173+
## [v0.4.1](https://github.com/purescript/purescript-free/releases/tag/v0.4.1) - 2015-03-19
174+
175+
Update docs
176+
177+
## [v0.4.0](https://github.com/purescript/purescript-free/releases/tag/v0.4.0) - 2015-03-02
178+
179+
- Rename `go`, `goM`, etc. to `runFree`, `runFreeM` etc.
180+
- Remove `iterM`, `goEff` and `goEffC`.
181+
- Update `goM` to work in any target monad which is an instance of `MonadRec`, which solves the issue of `goM` causing a stack overflow for large inputs.
182+
183+
## [v0.3.0](https://github.com/purescript/purescript-free/releases/tag/v0.3.0) - 2015-02-21
184+
185+
**This release requires PureScript v0.6.8 or later**
186+
- Updated dependencies
187+
188+
## [v0.2.0](https://github.com/purescript/purescript-free/releases/tag/v0.2.0) - 2015-01-10
189+
190+
- Updated dependencies (@garyb)
191+
192+
## [v0.1.6](https://github.com/purescript/purescript-free/releases/tag/v0.1.6) - 2014-12-02
193+
194+
- The `FreeC` type synonym is now partially applied (@ethul)
195+
196+
## [v0.1.5](https://github.com/purescript/purescript-free/releases/tag/v0.1.5) - 2014-11-30
197+
198+
Added `injC` and `mapF` for free monad composition (@ethul)
199+
200+
## [v0.1.4](https://github.com/purescript/purescript-free/releases/tag/v0.1.4) - 2014-11-18
201+
202+
Fixes for extracted `Identity`
203+
204+
## [v0.1.3](https://github.com/purescript/purescript-free/releases/tag/v0.1.3) - 2014-10-08
205+
206+
- Stopgap fix, `Cofree` constructor is exported as a workaround for purescript/purescript#618 (@jdegoes)
207+
208+
## [v0.1.2](https://github.com/purescript/purescript-free/releases/tag/v0.1.2) - 2014-10-07
209+
210+
- Remove bogus `mkCofree'` constructor (@jdegoes)
211+
- Remove unnecessary type variable from `Trampoline` type synonym (@jdegoes)
212+
213+
## [0.1.1](https://github.com/purescript/purescript-free/releases/tag/0.1.1) - 2014-10-01
214+
215+
216+
217+
## [0.1.0](https://github.com/purescript/purescript-free/releases/tag/0.1.0) - 2014-09-03
218+
219+
Relocating `Free` and `Trampoline` back to `purescript-free`, and adding `Yoneda` and `Coyoneda`.
220+
221+
## [0.0.8](https://github.com/purescript/purescript-free/releases/tag/0.0.8) - 2014-06-01
222+
223+
Specialization of `go` for `Eff` as discussed in issue #6
224+
225+
## [0.0.7](https://github.com/purescript/purescript-free/releases/tag/0.0.7) - 2014-05-15
226+
227+
Thanks to @puffnfresh!
228+
229+
## [0.0.6](https://github.com/purescript/purescript-free/releases/tag/0.0.6) - 2014-04-28
230+
231+
232+
233+
## [0.0.5](https://github.com/purescript/purescript-free/releases/tag/0.0.5) - 2014-04-28
234+
235+
236+
237+
## [0.0.4](https://github.com/purescript/purescript-free/releases/tag/0.0.4) - 2014-04-08
238+
239+
240+

0 commit comments

Comments
 (0)