Skip to content

Commit 0d6cb09

Browse files
Generate changelog and add PR template (#41)
* Generate CHANGELOG.md file using notes from previous GH releases * Add pull request template * Update CI in PS to v0.14.0-rc5
1 parent bee0b99 commit 0d6cb09

File tree

3 files changed

+95
-1
lines changed

3 files changed

+95
-1
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 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)

.github/workflows/ci.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ jobs:
1414

1515
- uses: purescript-contrib/setup-purescript@main
1616
with:
17-
purescript: "0.14.0-rc3"
17+
purescript: "0.14.0-rc5"
1818

1919
- uses: actions/setup-node@v1
2020
with:

CHANGELOG.md

+82
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
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+
## [v6.0.0](https://github.com/purescript-node/purescript-node-buffer/releases/tag/v6.0.0) - 2019-07-24
16+
17+
* Add a `MutableBuffer` type class with instances for both `Effect` and `ST`, to allow mutating buffers in either monad, and potentially other monads too (#24, @Dretch)
18+
* Remove the `Show Buffer` instance, as reading from a mutable buffer is effectful (@Dretch)
19+
* Use `Number` for reading and writing with Buffers (#25, @hdgarrood)
20+
21+
## [v5.0.0](https://github.com/purescript-node/purescript-node-buffer/releases/tag/v5.0.0) - 2018-05-26
22+
23+
Updated for PureScript 0.12
24+
25+
## [v4.1.0](https://github.com/purescript-node/purescript-node-buffer/releases/tag/v4.1.0) - 2017-12-11
26+
27+
Add `fromArrayBuffer` (@matthewleon)
28+
29+
## [v4.0.0](https://github.com/purescript-node/purescript-node-buffer/releases/tag/v4.0.0) - 2017-11-19
30+
31+
- Added `toArrayBuffer` (@matthewleon)
32+
33+
## [v3.0.1](https://github.com/purescript-node/purescript-node-buffer/releases/tag/v3.0.1) - 2017-06-20
34+
35+
Fix an encoding issue in `writeString` (@justinwoo)
36+
37+
## [v3.0.0](https://github.com/purescript-node/purescript-node-buffer/releases/tag/v3.0.0) - 2017-04-04
38+
39+
Updates for 0.11 (@anilanar)
40+
41+
## [v2.0.1](https://github.com/purescript-node/purescript-node-buffer/releases/tag/v2.0.1) - 2017-02-10
42+
43+
- Fixed `getAtOffset` FFI implementation (@rightfold)
44+
- Fixed documentation typo (@rightfold)
45+
46+
## [v2.0.0](https://github.com/purescript-node/purescript-node-buffer/releases/tag/v2.0.0) - 2016-10-17
47+
48+
- Updated dependencies (@nwolverson)
49+
- Added `latin1` encoding (@Risto-Stevcev)
50+
51+
## [v1.0.0](https://github.com/purescript-node/purescript-node-buffer/releases/tag/v1.0.0) - 2016-06-06
52+
53+
- Compatibility with psc 0.9
54+
- Better behaved `Show` instance, plus an `encodingToNode` function which is now recommended for use with node APIs instead of `show`.
55+
56+
## [v0.2.2](https://github.com/purescript-node/purescript-node-buffer/releases/tag/v0.2.2) - 2016-04-03
57+
58+
Fix `byteLength`, which had a bad FFI declaration, so that it would throw an error every time it was called.
59+
60+
## [v0.2.1](https://github.com/purescript-node/purescript-node-buffer/releases/tag/v0.2.1) - 2016-04-03
61+
62+
No code changes, this tag was just for publishing to Pursuit.
63+
64+
## [v0.2.0](https://github.com/purescript-node/purescript-node-buffer/releases/tag/v0.2.0) - 2015-11-11
65+
66+
- Major important fixes. This is a breaking change as type signatures have changed. (@hdgarrood)
67+
68+
## [v0.1.1](https://github.com/purescript-node/purescript-node-buffer/releases/tag/v0.1.1) - 2015-11-10
69+
70+
Release v0.1.1
71+
Fix `write`, `writeString`, and `fill`, which used to immediately throw errors at
72+
runtime upon use.
73+
74+
## [v0.1.0](https://github.com/purescript-node/purescript-node-buffer/releases/tag/v0.1.0) - 2015-07-06
75+
76+
- Support for compiler version 0.7
77+
- Use Int instead of Number where appropriate (which happens to be everywhere)
78+
79+
## [v0.0.1](https://github.com/purescript-node/purescript-node-buffer/releases/tag/v0.0.1) - 2014-10-14
80+
81+
Initial versioned release
82+

0 commit comments

Comments
 (0)