From 5074f723d393f4801769a4dd189b1f92049d9d32 Mon Sep 17 00:00:00 2001 From: Jordan Martinez Date: Sat, 9 Jan 2021 10:42:42 -0800 Subject: [PATCH 1/4] Generate CHANGELOG.md file using notes from previous GH releases --- CHANGELOG.md | 284 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 284 insertions(+) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 00000000..a636179a --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,284 @@ +# Changelog + +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). + +## [Unreleased] + +Breaking changes (😱!!!): + +New features: + +Bugfixes: + +Other improvements: + +## [v5.3.1](https://github.com/purescript/purescript-arrays/releases/tag/v5.3.1) - 2019-10-13 + +Replace use of unsafeCoerce in freeze/thaw functions with discrete foreign functions (@andyarvanitis) + +## [v5.3.0](https://github.com/purescript/purescript-arrays/releases/tag/v5.3.0) - 2019-04-27 + +Added `pop`, `shift`, `unshift`, `unshiftAll` for `Data.Array.ST` (@8084) + +## [v5.2.1](https://github.com/purescript/purescript-arrays/releases/tag/v5.2.1) - 2019-03-31 + +Performance improvement for `nubByEq` (@sharno) + +## [v5.2.0](https://github.com/purescript/purescript-arrays/releases/tag/v5.2.0) - 2018-12-16 + +- Added `run` function for `STArray` (@Dretch) + +## [v5.1.1](https://github.com/purescript/purescript-arrays/releases/tag/v5.1.1) - 2018-12-02 + +Fixed issue with `fill` polyfill not being included in the bundle by `purs bundle` (@maximedenes, @zyla) + +## [v5.1.0](https://github.com/purescript/purescript-arrays/releases/tag/v5.1.0) - 2018-09-25 + +* Make `groupBy` stable https://github.com/purescript/purescript-arrays/pull/148 (@LiamGoodacre) + +## [v5.0.0](https://github.com/purescript/purescript-arrays/releases/tag/v5.0.0) - 2018-05-23 + +- Updated for PureScript 0.12 +- Added `sort` functions for `STArray` (@matthewleon) +- `group` functions now return `NonEmptyArray` rather than `NonEmpty Array`s +- The `STArray` name prefixes have been dropped to reduce repetition when importing qualified +- Function argument order has been changed so that `STArray` is always the last argument +- `nub` (and related functions) now use `Ord` by default for a faster implementation, `Eq`-based variants are still available under new names + +## [v4.4.0](https://github.com/purescript/purescript-arrays/releases/tag/v4.4.0) - 2018-04-26 + +- Added `Semigroup` instance for `NonEmptyArray` + +## [v4.3.0](https://github.com/purescript/purescript-arrays/releases/tag/v4.3.0) - 2018-03-10 + +- Added `NonEmptyArray` (@matthewleon ) + +## [v4.2.2](https://github.com/purescript/purescript-arrays/releases/tag/v4.2.2) - 2017-12-16 + +* Add examples to the docs for most functions in `Data.Array` (@csicar) +* Remove some redundant parentheses (@matthewleon) + +## [v4.2.1](https://github.com/purescript/purescript-arrays/releases/tag/v4.2.1) - 2017-10-01 + +- Preallocate result of `range` (@jacereda) + +## [v4.2.0](https://github.com/purescript/purescript-arrays/releases/tag/v4.2.0) - 2017-09-05 + +Add `dropEnd` and `takeEnd` functions (@notgiorgi) + +## [v4.1.2](https://github.com/purescript/purescript-arrays/releases/tag/v4.1.2) - 2017-06-25 + +Fix some bugs in `Data.Array.ST.Partial` (@mhuisi) + +## [v4.1.1](https://github.com/purescript/purescript-arrays/releases/tag/v4.1.1) - 2017-06-20 + +* Improve performance of `unzip`; this function is now O(n) instead of O(n^2) +* Various documentation improvements + +## [v4.1.0](https://github.com/purescript/purescript-arrays/releases/tag/v4.1.0) - 2017-05-28 + +- Batch update and modify functions (@matthewleon) +- Partial functions for ST arrays (@matthewleon) + +## [v4.0.1](https://github.com/purescript/purescript-arrays/releases/tag/v4.0.1) - 2017-03-29 + +- Restored compiler-optimized TCO for `span` + +## [v4.0.0](https://github.com/purescript/purescript-arrays/releases/tag/v4.0.0) - 2017-03-26 + +- Updated for PureScript 0.11.0 +- `filterM` has been removed (`filterA` is better) (@hdgarrood) +- Improved performance of `concat` (@dikmax) +- Improved performance of `replicate` for browsers with `fill` (@dikmax) +- Added `sortWith` (@negator) + +## [v3.2.1](https://github.com/purescript/purescript-arrays/releases/tag/v3.2.1) - 2017-02-14 + +Avoid `Discard` constraints in upcoming 0.11 release. + +## [v3.2.0](https://github.com/purescript/purescript-arrays/releases/tag/v3.2.0) - 2017-01-20 + +- Add `Data.Array.ST.Iterator`, for iterating over things in ST computations +- Add `unsafeFreeze` for O(1) freezing of STArrays +- Use `~>` in the types for `toUnfoldable` and `fromFoldable` (@mlang) +- Performance boost for `groupBy`: was quadratic, now linear. + +## [v3.1.0](https://github.com/purescript/purescript-arrays/releases/tag/v3.1.0) - 2016-11-24 + +- Significant performance boosts for the following functions: + - `head` (now `O(1)`, was accidentally `O(n)`) + - `toUnfoldable` + - `span` + - `difference` +- Add `filterA`, which is just like `filterM`, but faster, and it only requires you to have an `Applicative` (not necessarily a `Monad`). +- Deprecate `filterM` in favour of `filterA`. In the next major release, `filterM` will be removed. +- Add `unsnoc` (@joshuahhh). + +## [v3.0.1](https://github.com/purescript/purescript-arrays/releases/tag/v3.0.1) - 2016-11-14 + +- Fixed shadowed name warning + +## [v3.0.0](https://github.com/purescript/purescript-arrays/releases/tag/v3.0.0) - 2016-10-09 + +- The `group` functions now return `NonEmpty` groups + +## [v2.0.0](https://github.com/purescript/purescript-arrays/releases/tag/v2.0.0) - 2016-10-07 + +- Updated dependencies +- `unsafeIndex` is exported from `Data.Array` rather than `Data.Array.Partial` now +- Array-specialised `replicate` is back +- Added stack safe version of `foldM` - `foldRecM` (@jutaro) +- Array now re-exports functions from `Foldable` and `Traversable` that might otherwise seem to be missing (@Risto-Stevcev) + +## [v1.1.0](https://github.com/purescript/purescript-arrays/releases/tag/v1.1.0) - 2016-07-26 + +- Added `mapWithIndex` (@damncabbage) + +## [v1.0.0](https://github.com/purescript/purescript-arrays/releases/tag/v1.0.0) - 2016-06-01 + +This release is intended for the PureScript 0.9.1 compiler and newer. + +**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. + +## [v1.0.0-rc.7](https://github.com/purescript/purescript-arrays/releases/tag/v1.0.0-rc.7) - 2016-05-20 + +- Fixed warning for unused FFI implementation + +## [v1.0.0-rc.6](https://github.com/purescript/purescript-arrays/releases/tag/v1.0.0-rc.6) - 2016-05-20 + +- Removed `replicate` and `replicateM` as these are provided via the unfoldable instance now + +## [v1.0.0-rc.5](https://github.com/purescript/purescript-arrays/releases/tag/v1.0.0-rc.5) - 2016-05-20 + +- Fixed unused import warning + +## [v1.0.0-rc.4](https://github.com/purescript/purescript-arrays/releases/tag/v1.0.0-rc.4) - 2016-04-04 + +- Added `toUnfoldable` + +## [v1.0.0-rc.3](https://github.com/purescript/purescript-arrays/releases/tag/v1.0.0-rc.3) - 2016-03-27 + +- Renamed `Data.Array.Unsafe` to `Data.Array.Partial` and added `Partial` constraint for parity with `purescript-lists`. + +## [v1.0.0-rc.2](https://github.com/purescript/purescript-arrays/releases/tag/v1.0.0-rc.2) - 2016-03-17 + +- Added `fromFoldable` (@hdgarrood) + +## [v1.0.0-rc.1](https://github.com/purescript/purescript-arrays/releases/tag/v1.0.0-rc.1) - 2016-03-16 + +- Release candidate for the psc 0.8+ core libraries + +## [v0.4.5](https://github.com/purescript/purescript-arrays/releases/tag/v0.4.5) - 2016-02-27 + +- Added `partition` (@raichoo) + +## [v0.4.4](https://github.com/purescript/purescript-arrays/releases/tag/v0.4.4) - 2015-12-11 + +- Document instances for Pursuit (@hdgarrood) + +## [v0.4.3](https://github.com/purescript/purescript-arrays/releases/tag/v0.4.3) - 2015-11-02 + +- Removed unused imports + +## [v0.4.2](https://github.com/purescript/purescript-arrays/releases/tag/v0.4.2) - 2015-08-13 + +- Fixed warnings about partial functions + +## [v0.4.1](https://github.com/purescript/purescript-arrays/releases/tag/v0.4.1) - 2015-07-29 + +- `replicateM` is now stack safe (@hdgarrood) + +## [v0.4.0](https://github.com/purescript/purescript-arrays/releases/tag/v0.4.0) - 2015-06-30 + +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. + +## [v0.4.0-rc.2](https://github.com/purescript/purescript-arrays/releases/tag/v0.4.0-rc.2) - 2015-06-07 + +Updates for parity with `purescript-lists`: +- Added `insert`, `insertBy`, `alterAt`, `union`, `unionBy` +- The `insertAt`, `modifyAt`, `deleteAt`... functions now return `Nothing` when given an out of range index + +## [v0.4.0-rc.1](https://github.com/purescript/purescript-arrays/releases/tag/v0.4.0-rc.1) - 2015-06-06 + +Initial release candidate of the library intended for the 0.7 compiler. + +## [v0.3.7](https://github.com/purescript/purescript-arrays/releases/tag/v0.3.7) - 2015-04-01 + +Add `replicate` (@jacereda) + +## [v0.3.6](https://github.com/purescript/purescript-arrays/releases/tag/v0.3.6) - 2015-03-24 + +Fix `pokeSTArray` bounds check (@jacereda) + +## [v0.3.5](https://github.com/purescript/purescript-arrays/releases/tag/v0.3.5) - 2015-03-18 + +Improve complexity of `head` and `last` (@hdgarrood) + +## [v0.3.4](https://github.com/purescript/purescript-arrays/releases/tag/v0.3.4) - 2015-03-17 + +Update docs + +## [v0.3.3](https://github.com/purescript/purescript-arrays/releases/tag/v0.3.3) - 2015-03-08 + +Add `modifyAt`. + +## [v0.3.2](https://github.com/purescript/purescript-arrays/releases/tag/v0.3.2) - 2015-02-18 + + + +## [v0.3.1](https://github.com/purescript/purescript-arrays/releases/tag/v0.3.1) - 2015-01-24 + +Add `take` and `drop`. + +## [v0.3.0](https://github.com/purescript/purescript-arrays/releases/tag/v0.3.0) - 2014-11-28 + +Add new `ST` functions. + +## [v0.2.1](https://github.com/purescript/purescript-arrays/releases/tag/v0.2.1) - 2014-08-23 + +Include `(..)` operator. + +## [v0.2.0](https://github.com/purescript/purescript-arrays/releases/tag/v0.2.0) - 2014-08-11 + +- Add `Alt`, `Plus`, `MonadPlus`, update `Alternative` (@garyb) + +## [v0.1.8](https://github.com/purescript/purescript-arrays/releases/tag/v0.1.8) - 2014-05-30 + + + +## [v0.1.7](https://github.com/purescript/purescript-arrays/releases/tag/v0.1.7) - 2014-05-29 + + + +## [v0.1.6](https://github.com/purescript/purescript-arrays/releases/tag/v0.1.6) - 2014-05-22 + +- Added `delete`, `deleteBy`, `(\\)` (garyb) +- Added `intersect`, `intersectBy`, and `last` in `Data.Array.Unsafe` (paf31) + +## [v0.1.5](https://github.com/purescript/purescript-arrays/releases/tag/v0.1.5) - 2014-05-22 + +- Added `group`, `groupBy`, `span` (joneshf) +- Added `catMaybes` (garyb) + +## [v0.1.4](https://github.com/purescript/purescript-arrays/releases/tag/v0.1.4) - 2014-05-08 + +- Added `sortBy` (joneshf) + +## [v0.1.3](https://github.com/purescript/purescript-arrays/releases/tag/v0.1.3) - 2014-05-05 + +- Removed `elem` as it is implemented in `Data.Foldable` +- Updated `elemIndex` and `elemLastIndex` to use `Eq` when finding items. +- Added `findIndex` and `findLastIndex` to find an item with a predicate. + +## [v0.1.2](https://github.com/purescript/purescript-arrays/releases/tag/v0.1.2) - 2014-05-03 + +Added `mapMaybe` + +## [v0.1.1](https://github.com/purescript/purescript-arrays/releases/tag/v0.1.1) - 2014-04-27 + + + +## [v0.1.0](https://github.com/purescript/purescript-arrays/releases/tag/v0.1.0) - 2014-04-25 + + + From e1dfef7b92a7af41b24f9e0458f88e9265e7bfe3 Mon Sep 17 00:00:00 2001 From: Jordan Martinez Date: Sat, 9 Jan 2021 10:42:42 -0800 Subject: [PATCH 2/4] Add pull request template --- .github/PULL_REQUEST_TEMPLATE.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..11adcaa8 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,12 @@ +**Description of the change** + +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. + +--- + +**Checklist:** + +- [ ] Added the change to the changelog's "Unreleased" section with a link to this PR and your username +- [ ] Linked any existing issues or proposals that this pull request should close +- [ ] Updated or added relevant documentation in the README and/or documentation directory +- [ ] Added a test for the contribution (if applicable) From 94373cb8d2e5328e9b946b0e25cb8b4eb1425a4b Mon Sep 17 00:00:00 2001 From: JordanMartinez Date: Sat, 9 Jan 2021 10:48:41 -0800 Subject: [PATCH 3/4] Remove screaming emoji --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index a636179a..7c5a817f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,7 +4,7 @@ Notable changes to this project are documented in this file. The format is based ## [Unreleased] -Breaking changes (😱!!!): +Breaking changes: New features: From 4775b1e2c143a9c37fda55e1bd2ab76295d465f1 Mon Sep 17 00:00:00 2001 From: JordanMartinez Date: Sun, 10 Jan 2021 06:24:25 -0800 Subject: [PATCH 4/4] Fix PR template of various issues raised earlier --- .github/PULL_REQUEST_TEMPLATE.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 11adcaa8..4435abbe 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -6,7 +6,7 @@ Clearly and concisely describe the purpose of the pull request. If this PR relat **Checklist:** -- [ ] Added the change to the changelog's "Unreleased" section with a link to this PR and your username +- [ ] Added the change to the changelog's "Unreleased" section with a reference to this PR (e.g. "- Made a change (#0000)") - [ ] Linked any existing issues or proposals that this pull request should close -- [ ] Updated or added relevant documentation in the README and/or documentation directory +- [ ] Updated or added relevant documentation - [ ] Added a test for the contribution (if applicable)