Skip to content

Write changelog for upcoming release #255

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 12 commits into from
Jan 13, 2021
Merged

Write changelog for upcoming release #255

Changes from 7 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
65b53cb
Write changelog for upcoming release
JordanMartinez Jan 11, 2021
bc0ed12
Add v4.1.1 release to changelog
JordanMartinez Jan 12, 2021
4014134
Document changes that happened in v4.1.1 release
JordanMartinez Jan 12, 2021
7a1b9b6
Add #229 to breaking changes
JordanMartinez Jan 12, 2021
e5e948a
Remove backticks around 'do notation'
JordanMartinez Jan 13, 2021
4afb2bd
Rephrase 'make library compile on v0.14.0'
JordanMartinez Jan 13, 2021
26a197d
Separate documentation improvement PRs from other improvements
JordanMartinez Jan 13, 2021
321b5f9
Include other PR related to v0.14.0 in changelog
JordanMartinez Jan 13, 2021
b0ec190
Add toRep PR
JordanMartinez Jan 13, 2021
4c606f8
Put Array do notation and Monoid newtype PR summary on one line
JordanMartinez Jan 13, 2021
4b978f1
Include PR that fixes typo
JordanMartinez Jan 13, 2021
c35562b
Change section header back to Unreleased
JordanMartinez Jan 13, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 35 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,41 @@ Bugfixes:

Other improvements:

## [v5.0.0](https://github.com/purescript/purescript-prelude/releases/tag/v4.1.0) - 2021-MONTH-DATE
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, last thing, maybe it would be good to leave this stuff under "Unreleased" for now so that we don't forget to update the placeholder link and date? I don't really mind though.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense to me. I'll add that change and then merge.


Breaking changes:
- Support compiler version `v0.14.0`, and drop support for previous versions (#206)
- `purescript-proxy` was ported to this repo (#230)
- `purescript-generics-rep` was ported to this repo (#235)
- Move the `Applicative` Superclass law from `Monad` to `Bind` and rename it
to the `Apply` Superclass law (#229)

New features:
- Added `Bounded` instance for records (#208)
- Added `Show` instances to `Data.Generics.Rep` types (#250)

Bugfixes:
- No longer use reference equality check in `Array`'s `Eq` instance because it breaks referential transparency (#187).
- Fix Ring laws (#228)

Documentation improvements:
- Added `lift2` example using `Maybe` (#213)
- Added `const` example (#214)
- Added `power` example (#253)
- Improve documentation in various things (#217)
- Clarify `Array`'s "do notation"
- Clarify purpose of `Monoid` and `Semigroup` newtypes
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think having a bullet point labelled "improve documentation in various things" under a parent "Documentation improvements" is a bit redundant. How about:

Suggested change
- Improve documentation in various things (#217)
- Clarify `Array`'s "do notation"
- Clarify purpose of `Monoid` and `Semigroup` newtypes
- Clarify `Array`'s do notation and the purposes of `Monoid` and `Semigroup` newtypes (#217)

- Clarify `Unit` representation in FFI code (#223)

Other improvements:
- Migrated to GitHub Actions (#234)
- Added a `CHANGELOG.md` file and PR template (#254)

## [v4.1.1](https://github.com/purescript/purescript-prelude/releases/tag/v4.1.1) - 2019-04-20

- Added documentation fixes/improvements to `Data.Monoid.Conj` and other `Data.Monoid` newtypes (#191, #192)
- Made `Eq` and `Ord` instances for primitive types less JavaScript-specific (#183)

## [v4.1.0](https://github.com/purescript/purescript-prelude/releases/tag/v4.1.0) - 2018-07-17

- Added `Ord` instance for records
Expand Down Expand Up @@ -160,4 +195,3 @@ This release works with versions 0.7.\* of the PureScript compiler. It will not
## [v0.1.0-rc.1](https://github.com/purescript/purescript-prelude/releases/tag/v0.1.0-rc.1) - 2015-06-06

Initial release candidate.