Skip to content

Commit 5902f56

Browse files
JordanMartinezJordanMartinez
authored
Generate changelog and add PR template (#208)
* Generate CHANGELOG.md file using notes from previous GH releases * Add pull request template
1 parent 7d3664d commit 5902f56

File tree

2 files changed

+296
-0
lines changed

2 files changed

+296
-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: 284 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,284 @@
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.3.1](https://github.com/purescript/purescript-arrays/releases/tag/v5.3.1) - 2019-10-13
16+
17+
Replace use of unsafeCoerce in freeze/thaw functions with discrete foreign functions (@andyarvanitis)
18+
19+
## [v5.3.0](https://github.com/purescript/purescript-arrays/releases/tag/v5.3.0) - 2019-04-27
20+
21+
Added `pop`, `shift`, `unshift`, `unshiftAll` for `Data.Array.ST` (@8084)
22+
23+
## [v5.2.1](https://github.com/purescript/purescript-arrays/releases/tag/v5.2.1) - 2019-03-31
24+
25+
Performance improvement for `nubByEq` (@sharno)
26+
27+
## [v5.2.0](https://github.com/purescript/purescript-arrays/releases/tag/v5.2.0) - 2018-12-16
28+
29+
- Added `run` function for `STArray` (@Dretch)
30+
31+
## [v5.1.1](https://github.com/purescript/purescript-arrays/releases/tag/v5.1.1) - 2018-12-02
32+
33+
Fixed issue with `fill` polyfill not being included in the bundle by `purs bundle` (@maximedenes, @zyla)
34+
35+
## [v5.1.0](https://github.com/purescript/purescript-arrays/releases/tag/v5.1.0) - 2018-09-25
36+
37+
* Make `groupBy` stable https://github.com/purescript/purescript-arrays/pull/148 (@LiamGoodacre)
38+
39+
## [v5.0.0](https://github.com/purescript/purescript-arrays/releases/tag/v5.0.0) - 2018-05-23
40+
41+
- Updated for PureScript 0.12
42+
- Added `sort` functions for `STArray` (@matthewleon)
43+
- `group` functions now return `NonEmptyArray` rather than `NonEmpty Array`s
44+
- The `STArray` name prefixes have been dropped to reduce repetition when importing qualified
45+
- Function argument order has been changed so that `STArray` is always the last argument
46+
- `nub` (and related functions) now use `Ord` by default for a faster implementation, `Eq`-based variants are still available under new names
47+
48+
## [v4.4.0](https://github.com/purescript/purescript-arrays/releases/tag/v4.4.0) - 2018-04-26
49+
50+
- Added `Semigroup` instance for `NonEmptyArray`
51+
52+
## [v4.3.0](https://github.com/purescript/purescript-arrays/releases/tag/v4.3.0) - 2018-03-10
53+
54+
- Added `NonEmptyArray` (@matthewleon )
55+
56+
## [v4.2.2](https://github.com/purescript/purescript-arrays/releases/tag/v4.2.2) - 2017-12-16
57+
58+
* Add examples to the docs for most functions in `Data.Array` (@csicar)
59+
* Remove some redundant parentheses (@matthewleon)
60+
61+
## [v4.2.1](https://github.com/purescript/purescript-arrays/releases/tag/v4.2.1) - 2017-10-01
62+
63+
- Preallocate result of `range` (@jacereda)
64+
65+
## [v4.2.0](https://github.com/purescript/purescript-arrays/releases/tag/v4.2.0) - 2017-09-05
66+
67+
Add `dropEnd` and `takeEnd` functions (@notgiorgi)
68+
69+
## [v4.1.2](https://github.com/purescript/purescript-arrays/releases/tag/v4.1.2) - 2017-06-25
70+
71+
Fix some bugs in `Data.Array.ST.Partial` (@mhuisi)
72+
73+
## [v4.1.1](https://github.com/purescript/purescript-arrays/releases/tag/v4.1.1) - 2017-06-20
74+
75+
* Improve performance of `unzip`; this function is now O(n) instead of O(n^2)
76+
* Various documentation improvements
77+
78+
## [v4.1.0](https://github.com/purescript/purescript-arrays/releases/tag/v4.1.0) - 2017-05-28
79+
80+
- Batch update and modify functions (@matthewleon)
81+
- Partial functions for ST arrays (@matthewleon)
82+
83+
## [v4.0.1](https://github.com/purescript/purescript-arrays/releases/tag/v4.0.1) - 2017-03-29
84+
85+
- Restored compiler-optimized TCO for `span`
86+
87+
## [v4.0.0](https://github.com/purescript/purescript-arrays/releases/tag/v4.0.0) - 2017-03-26
88+
89+
- Updated for PureScript 0.11.0
90+
- `filterM` has been removed (`filterA` is better) (@hdgarrood)
91+
- Improved performance of `concat` (@dikmax)
92+
- Improved performance of `replicate` for browsers with `fill` (@dikmax)
93+
- Added `sortWith` (@negator)
94+
95+
## [v3.2.1](https://github.com/purescript/purescript-arrays/releases/tag/v3.2.1) - 2017-02-14
96+
97+
Avoid `Discard` constraints in upcoming 0.11 release.
98+
99+
## [v3.2.0](https://github.com/purescript/purescript-arrays/releases/tag/v3.2.0) - 2017-01-20
100+
101+
- Add `Data.Array.ST.Iterator`, for iterating over things in ST computations
102+
- Add `unsafeFreeze` for O(1) freezing of STArrays
103+
- Use `~>` in the types for `toUnfoldable` and `fromFoldable` (@mlang)
104+
- Performance boost for `groupBy`: was quadratic, now linear.
105+
106+
## [v3.1.0](https://github.com/purescript/purescript-arrays/releases/tag/v3.1.0) - 2016-11-24
107+
108+
- Significant performance boosts for the following functions:
109+
- `head` (now `O(1)`, was accidentally `O(n)`)
110+
- `toUnfoldable`
111+
- `span`
112+
- `difference`
113+
- Add `filterA`, which is just like `filterM`, but faster, and it only requires you to have an `Applicative` (not necessarily a `Monad`).
114+
- Deprecate `filterM` in favour of `filterA`. In the next major release, `filterM` will be removed.
115+
- Add `unsnoc` (@joshuahhh).
116+
117+
## [v3.0.1](https://github.com/purescript/purescript-arrays/releases/tag/v3.0.1) - 2016-11-14
118+
119+
- Fixed shadowed name warning
120+
121+
## [v3.0.0](https://github.com/purescript/purescript-arrays/releases/tag/v3.0.0) - 2016-10-09
122+
123+
- The `group` functions now return `NonEmpty` groups
124+
125+
## [v2.0.0](https://github.com/purescript/purescript-arrays/releases/tag/v2.0.0) - 2016-10-07
126+
127+
- Updated dependencies
128+
- `unsafeIndex` is exported from `Data.Array` rather than `Data.Array.Partial` now
129+
- Array-specialised `replicate` is back
130+
- Added stack safe version of `foldM` - `foldRecM` (@jutaro)
131+
- Array now re-exports functions from `Foldable` and `Traversable` that might otherwise seem to be missing (@Risto-Stevcev)
132+
133+
## [v1.1.0](https://github.com/purescript/purescript-arrays/releases/tag/v1.1.0) - 2016-07-26
134+
135+
- Added `mapWithIndex` (@damncabbage)
136+
137+
## [v1.0.0](https://github.com/purescript/purescript-arrays/releases/tag/v1.0.0) - 2016-06-01
138+
139+
This release is intended for the PureScript 0.9.1 compiler and newer.
140+
141+
**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.
142+
143+
## [v1.0.0-rc.7](https://github.com/purescript/purescript-arrays/releases/tag/v1.0.0-rc.7) - 2016-05-20
144+
145+
- Fixed warning for unused FFI implementation
146+
147+
## [v1.0.0-rc.6](https://github.com/purescript/purescript-arrays/releases/tag/v1.0.0-rc.6) - 2016-05-20
148+
149+
- Removed `replicate` and `replicateM` as these are provided via the unfoldable instance now
150+
151+
## [v1.0.0-rc.5](https://github.com/purescript/purescript-arrays/releases/tag/v1.0.0-rc.5) - 2016-05-20
152+
153+
- Fixed unused import warning
154+
155+
## [v1.0.0-rc.4](https://github.com/purescript/purescript-arrays/releases/tag/v1.0.0-rc.4) - 2016-04-04
156+
157+
- Added `toUnfoldable`
158+
159+
## [v1.0.0-rc.3](https://github.com/purescript/purescript-arrays/releases/tag/v1.0.0-rc.3) - 2016-03-27
160+
161+
- Renamed `Data.Array.Unsafe` to `Data.Array.Partial` and added `Partial` constraint for parity with `purescript-lists`.
162+
163+
## [v1.0.0-rc.2](https://github.com/purescript/purescript-arrays/releases/tag/v1.0.0-rc.2) - 2016-03-17
164+
165+
- Added `fromFoldable` (@hdgarrood)
166+
167+
## [v1.0.0-rc.1](https://github.com/purescript/purescript-arrays/releases/tag/v1.0.0-rc.1) - 2016-03-16
168+
169+
- Release candidate for the psc 0.8+ core libraries
170+
171+
## [v0.4.5](https://github.com/purescript/purescript-arrays/releases/tag/v0.4.5) - 2016-02-27
172+
173+
- Added `partition` (@raichoo)
174+
175+
## [v0.4.4](https://github.com/purescript/purescript-arrays/releases/tag/v0.4.4) - 2015-12-11
176+
177+
- Document instances for Pursuit (@hdgarrood)
178+
179+
## [v0.4.3](https://github.com/purescript/purescript-arrays/releases/tag/v0.4.3) - 2015-11-02
180+
181+
- Removed unused imports
182+
183+
## [v0.4.2](https://github.com/purescript/purescript-arrays/releases/tag/v0.4.2) - 2015-08-13
184+
185+
- Fixed warnings about partial functions
186+
187+
## [v0.4.1](https://github.com/purescript/purescript-arrays/releases/tag/v0.4.1) - 2015-07-29
188+
189+
- `replicateM` is now stack safe (@hdgarrood)
190+
191+
## [v0.4.0](https://github.com/purescript/purescript-arrays/releases/tag/v0.4.0) - 2015-06-30
192+
193+
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.
194+
195+
## [v0.4.0-rc.2](https://github.com/purescript/purescript-arrays/releases/tag/v0.4.0-rc.2) - 2015-06-07
196+
197+
Updates for parity with `purescript-lists`:
198+
- Added `insert`, `insertBy`, `alterAt`, `union`, `unionBy`
199+
- The `insertAt`, `modifyAt`, `deleteAt`... functions now return `Nothing` when given an out of range index
200+
201+
## [v0.4.0-rc.1](https://github.com/purescript/purescript-arrays/releases/tag/v0.4.0-rc.1) - 2015-06-06
202+
203+
Initial release candidate of the library intended for the 0.7 compiler.
204+
205+
## [v0.3.7](https://github.com/purescript/purescript-arrays/releases/tag/v0.3.7) - 2015-04-01
206+
207+
Add `replicate` (@jacereda)
208+
209+
## [v0.3.6](https://github.com/purescript/purescript-arrays/releases/tag/v0.3.6) - 2015-03-24
210+
211+
Fix `pokeSTArray` bounds check (@jacereda)
212+
213+
## [v0.3.5](https://github.com/purescript/purescript-arrays/releases/tag/v0.3.5) - 2015-03-18
214+
215+
Improve complexity of `head` and `last` (@hdgarrood)
216+
217+
## [v0.3.4](https://github.com/purescript/purescript-arrays/releases/tag/v0.3.4) - 2015-03-17
218+
219+
Update docs
220+
221+
## [v0.3.3](https://github.com/purescript/purescript-arrays/releases/tag/v0.3.3) - 2015-03-08
222+
223+
Add `modifyAt`.
224+
225+
## [v0.3.2](https://github.com/purescript/purescript-arrays/releases/tag/v0.3.2) - 2015-02-18
226+
227+
228+
229+
## [v0.3.1](https://github.com/purescript/purescript-arrays/releases/tag/v0.3.1) - 2015-01-24
230+
231+
Add `take` and `drop`.
232+
233+
## [v0.3.0](https://github.com/purescript/purescript-arrays/releases/tag/v0.3.0) - 2014-11-28
234+
235+
Add new `ST` functions.
236+
237+
## [v0.2.1](https://github.com/purescript/purescript-arrays/releases/tag/v0.2.1) - 2014-08-23
238+
239+
Include `(..)` operator.
240+
241+
## [v0.2.0](https://github.com/purescript/purescript-arrays/releases/tag/v0.2.0) - 2014-08-11
242+
243+
- Add `Alt`, `Plus`, `MonadPlus`, update `Alternative` (@garyb)
244+
245+
## [v0.1.8](https://github.com/purescript/purescript-arrays/releases/tag/v0.1.8) - 2014-05-30
246+
247+
248+
249+
## [v0.1.7](https://github.com/purescript/purescript-arrays/releases/tag/v0.1.7) - 2014-05-29
250+
251+
252+
253+
## [v0.1.6](https://github.com/purescript/purescript-arrays/releases/tag/v0.1.6) - 2014-05-22
254+
255+
- Added `delete`, `deleteBy`, `(\\)` (garyb)
256+
- Added `intersect`, `intersectBy`, and `last` in `Data.Array.Unsafe` (paf31)
257+
258+
## [v0.1.5](https://github.com/purescript/purescript-arrays/releases/tag/v0.1.5) - 2014-05-22
259+
260+
- Added `group`, `groupBy`, `span` (joneshf)
261+
- Added `catMaybes` (garyb)
262+
263+
## [v0.1.4](https://github.com/purescript/purescript-arrays/releases/tag/v0.1.4) - 2014-05-08
264+
265+
- Added `sortBy` (joneshf)
266+
267+
## [v0.1.3](https://github.com/purescript/purescript-arrays/releases/tag/v0.1.3) - 2014-05-05
268+
269+
- Removed `elem` as it is implemented in `Data.Foldable`
270+
- Updated `elemIndex` and `elemLastIndex` to use `Eq` when finding items.
271+
- Added `findIndex` and `findLastIndex` to find an item with a predicate.
272+
273+
## [v0.1.2](https://github.com/purescript/purescript-arrays/releases/tag/v0.1.2) - 2014-05-03
274+
275+
Added `mapMaybe`
276+
277+
## [v0.1.1](https://github.com/purescript/purescript-arrays/releases/tag/v0.1.1) - 2014-04-27
278+
279+
280+
281+
## [v0.1.0](https://github.com/purescript/purescript-arrays/releases/tag/v0.1.0) - 2014-04-25
282+
283+
284+

0 commit comments

Comments
 (0)