Skip to content

Commit 5198425

Browse files
JordanMartinezturlando
authored andcommitted
Generate CHANGELOG.md file using notes from previous GH releases (purescript#252)
* Generate CHANGELOG.md file using notes from previous GH releases * Add pull request template
1 parent 5f01581 commit 5198425

File tree

2 files changed

+175
-0
lines changed

2 files changed

+175
-0
lines changed

.github/PULL_REQUEST_TEMPLATE.md

+12
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 link to this PR and your username
10+
- [ ] Linked any existing issues or proposals that this pull request should close
11+
- [ ] Updated or added relevant documentation in the README and/or documentation directory
12+
- [ ] Added a test for the contribution (if applicable)

CHANGELOG.md

+163
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,163 @@
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+
## [v4.1.0](https://github.com/purescript/purescript-prelude/releases/tag/v4.1.0) - 2018-07-17
16+
17+
- Added `Ord` instance for records
18+
19+
## [v4.0.1](https://github.com/purescript/purescript-prelude/releases/tag/v4.0.1) - 2018-06-07
20+
21+
- Performance improvement for `Array` equality, now performs a reference check before comparing contents (@jazmit)
22+
23+
## [v4.0.0](https://github.com/purescript/purescript-prelude/releases/tag/v4.0.0) - 2018-05-22
24+
25+
This version is for PureScript v0.12.x.
26+
27+
**Breaking changes**
28+
29+
- `id` has been renamed to `identity`
30+
- The modulo and division behaviour for integers is now based on Euclidean division. Functions implementing the old `div`/`mod` behaviour are available as `quot`/`rem` in [`purescript-integers`](https://github.com/purescript/purescript-integers). (#161, #168)
31+
- The definition of `Field` has been altered. It is no longer necessary to provide an instance for this, there is a single instance now for every type that implements `EuclideanRing` and `DivisionRing` .
32+
33+
**Other changes**
34+
35+
- `Monoid` has been moved into the prelude
36+
- `Data.Symbol` has been moved into the prelude
37+
- `RProxy` and `RLProxy` have been moved into the prelude
38+
- There are now various instances available for records: `Eq`, `Show`, `Semigroup`, `Monoid`, `Semiring`... etc. (@i-am-tom)
39+
40+
## [v3.3.0](https://github.com/purescript/purescript-prelude/releases/tag/v3.3.0) - 2018-04-13
41+
42+
- Added `Data.Function.applyN` for repeatedly applying a function to an initial value (@matthewleon)
43+
44+
## [v3.2.0](https://github.com/purescript/purescript-prelude/releases/tag/v3.2.0) - 2018-04-07
45+
46+
- Added `Bounded` instance for `Number` (@erisco)
47+
48+
## [v3.1.1](https://github.com/purescript/purescript-prelude/releases/tag/v3.1.1) - 2017-11-01
49+
50+
Remove unused `refIneq` function (@metaleap)
51+
52+
## [v3.1.0](https://github.com/purescript/purescript-prelude/releases/tag/v3.1.0) - 2017-06-27
53+
54+
* Fixes for out-of-date documentation (@joneshf, @matthewleon)
55+
* Add a new `DivisionRing` class
56+
57+
## [v3.0.0](https://github.com/purescript/purescript-prelude/releases/tag/v3.0.0) - 2017-03-25
58+
59+
- Updated for PureScript 0.11
60+
- Removed incorrect `EuclideanRing Unit` and `Field Unit` instances
61+
62+
## [v2.5.0](https://github.com/purescript/purescript-prelude/releases/tag/v2.5.0) - 2017-03-02
63+
64+
- Added `Eq1` and `Ord1` classes
65+
66+
## [v2.4.0](https://github.com/purescript/purescript-prelude/releases/tag/v2.4.0) - 2017-02-13
67+
68+
- Add the new `Discard` class to support https://github.com/purescript/purescript/pull/2653
69+
- Fixes a corner case in the `degree` function for `Int`.
70+
- Documentation fixes
71+
72+
## [v2.3.0](https://github.com/purescript/purescript-prelude/releases/tag/v2.3.0) - 2017-01-29
73+
74+
- Added `gcd` and `lcm` for any `EuclideanRing`.
75+
- Fixed some issues with the `EuclideanRing` laws. The `Unit` instance is no longer valid, but is being kept around temporarily for the sake of backwards compatibility.
76+
77+
## [v2.2.0](https://github.com/purescript/purescript-prelude/releases/tag/v2.2.0) - 2017-01-26
78+
79+
- Added instances of the form `C b => C (a -> b)` for `Semiring`, `Ring`, `CommutativeRing`, `BooleanAlgebra`
80+
- Added some documentation for the `Void` type (@chexxor)
81+
- Fixed documentation typos (@mlang, @thoradam)
82+
83+
## [v2.1.0](https://github.com/purescript/purescript-prelude/releases/tag/v2.1.0) - 2016-09-30
84+
85+
- Added `whenM` and `unlessM` variants of `when` and `unless` for situations where the conditional is also in `m`
86+
87+
## [v2.0.0](https://github.com/purescript/purescript-prelude/releases/tag/v2.0.0) - 2016-09-26
88+
89+
**Breaking changes**
90+
- Fixed `=<<` to be right associative, as originally intended
91+
- Changed behaviour of `Eq` and `Ord` for `NaN` numeric value #91 (@berdario)
92+
93+
**Enhancements**
94+
- Updated docs to include notes about the non-law-abiding numeric instances
95+
- Semigroup `append` for `Array` will no longer shallow copy the array if either side is empty #63 (suggested by @natefaubion)
96+
97+
## [v1.1.0](https://github.com/purescript/purescript-prelude/releases/tag/v1.1.0) - 2016-09-26
98+
99+
- Added `flap` and corresponding `<@>` operator (@joneshf)
100+
101+
## [v1.0.1](https://github.com/purescript/purescript-prelude/releases/tag/v1.0.1) - 2016-06-07
102+
103+
- A redundant `CommutativeRing` constraint was removed from `Field`, the `EuclideanRing` constraint already implies `CommutativeRing`.
104+
105+
## [v1.0.0](https://github.com/purescript/purescript-prelude/releases/tag/v1.0.0) - 2016-06-01
106+
107+
This release is intended for the PureScript 0.9.1 compiler and newer.
108+
109+
**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.
110+
111+
## [v1.0.0-rc.6](https://github.com/purescript/purescript-prelude/releases/tag/v1.0.0-rc.6) - 2016-05-23
112+
113+
- Added `Data.NaturalTransformation` with a synonym and type operator alias for natural transformations
114+
115+
## [v1.0.0-rc.5](https://github.com/purescript/purescript-prelude/releases/tag/v1.0.0-rc.5) - 2016-05-22
116+
117+
- Added general `abs` and `signum` for types that with `Ord` and `Ring` instances (@hdgarrood)
118+
119+
## [v1.0.0-rc.4](https://github.com/purescript/purescript-prelude/releases/tag/v1.0.0-rc.4) - 2016-05-19
120+
121+
- Various fixes
122+
123+
## [v0.1.5](https://github.com/purescript/purescript-prelude/releases/tag/v0.1.5) - 2016-03-30
124+
125+
- Fixes invalid escape sequence in `Show` (@michaelficarra, #65)
126+
127+
## [v1.0.0-rc.3](https://github.com/purescript/purescript-prelude/releases/tag/v1.0.0-rc.3) - 2016-03-30
128+
129+
- Fixed escaping in `Show` #65
130+
131+
## [v1.0.0-rc.2](https://github.com/purescript/purescript-prelude/releases/tag/v1.0.0-rc.2) - 2016-03-20
132+
133+
- Reworked the hierarchy for number classes to resolve some issues with the laws and admit new instances #61
134+
- Introduced `HeytingAlgebra` as a superclass of `BooleanAlgebra` #62
135+
136+
## [v1.0.0-rc.1](https://github.com/purescript/purescript-prelude/releases/tag/v1.0.0-rc.1) - 2016-02-29
137+
138+
- Release candidate for the psc 0.8+ prelude
139+
140+
## [v0.1.4](https://github.com/purescript/purescript-prelude/releases/tag/v0.1.4) - 2016-01-27
141+
142+
- Fixed the escaping used in `Show` for `Char` and `String` (@michaelficarra)
143+
144+
## [v0.1.3](https://github.com/purescript/purescript-prelude/releases/tag/v0.1.3) - 2015-10-13
145+
146+
Move `Int` bounds to foreign module (@andyarvanitis)
147+
148+
## [v0.1.2](https://github.com/purescript/purescript-prelude/releases/tag/v0.1.2) - 2015-08-13
149+
150+
Add `Bounded Char` instance (@garyb)
151+
152+
## [v0.1.1](https://github.com/purescript/purescript-prelude/releases/tag/v0.1.1) - 2015-07-26
153+
154+
Export `unsafeCompare`
155+
156+
## [v0.1.0](https://github.com/purescript/purescript-prelude/releases/tag/v0.1.0) - 2015-06-30
157+
158+
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.
159+
160+
## [v0.1.0-rc.1](https://github.com/purescript/purescript-prelude/releases/tag/v0.1.0-rc.1) - 2015-06-06
161+
162+
Initial release candidate.
163+

0 commit comments

Comments
 (0)