Skip to content

Commit 6e27e11

Browse files
Generate changelog and add PR template (purescript#140)
* Generate CHANGELOG.md file using notes from previous GH releases * Add pull request template
1 parent 5815ea9 commit 6e27e11

File tree

2 files changed

+240
-0
lines changed

2 files changed

+240
-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 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

+228
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,228 @@
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.0.2](https://github.com/purescript/purescript-strings/releases/tag/v4.0.2) - 2020-05-13
16+
17+
- Improved performance for `stripPrefix` / `stripSuffix` (#123, @michaelficarra)
18+
19+
## [v4.0.1](https://github.com/purescript/purescript-strings/releases/tag/v4.0.1) - 2018-11-11
20+
21+
- Fixed out of bounds access in `unsafeCodePointAt0Fallback` (@zyla)
22+
- Fixed `slice` when end index equals string length (@abaco)
23+
24+
## [v4.0.0](https://github.com/purescript/purescript-strings/releases/tag/v4.0.0) - 2018-05-23
25+
26+
- Updated for PureScript 0.12
27+
- `splitAt` now always returns a value (#78, @MonoidMusician)
28+
- Added `slice` (@themattchan)
29+
- Added more `String` `Gen`s to correspond with `Char` `Gen`s (@matthewleon)
30+
- `Regex` `match` now returns `NonEmptyArray`
31+
- All string functions now operate on code points now rather than code units. The old functions are available via the `.CodeUnits` modules
32+
- `fromCharCode` can return `Nothing` now if given a value out of range
33+
34+
## [v3.5.0](https://github.com/purescript/purescript-strings/releases/tag/v3.5.0) - 2018-02-12
35+
36+
- Added `Data.String.NonEmpty`
37+
38+
## [v3.4.0](https://github.com/purescript/purescript-strings/releases/tag/v3.4.0) - 2017-12-28
39+
40+
* Add `Show CodePoint` instance (@csicar)
41+
* Add `codePointFromChar` (@csicar)
42+
* Expanded docs for most functions in `Data.String` and `Data.String.CodePoints` (@csicar)
43+
44+
## [v3.3.2](https://github.com/purescript/purescript-strings/releases/tag/v3.3.2) - 2017-11-19
45+
46+
Performance improvement in `Data.String.Regex.match` (@fehrenbach)
47+
48+
## [v3.3.1](https://github.com/purescript/purescript-strings/releases/tag/v3.3.1) - 2017-08-06
49+
50+
Fix some `Show` instances (@Rufflewind)
51+
52+
## [v3.3.0](https://github.com/purescript/purescript-strings/releases/tag/v3.3.0) - 2017-07-10
53+
54+
* Add a new module `Data.String.CodePoints`, which treats strings as sequences of Unicode code points rather than sequences of UTF-16 code units. In the future we may swap this module with `Data.String`. (@michaelficarra)
55+
* Fix a typo in the documentation (@ijks)
56+
57+
## [v3.2.1](https://github.com/purescript/purescript-strings/releases/tag/v3.2.1) - 2017-06-06
58+
59+
- Ensure `genString` behaves the same regardless of the `MonadGen` implementation of `chooseInt` when `max < min`
60+
61+
## [v3.2.0](https://github.com/purescript/purescript-strings/releases/tag/v3.2.0) - 2017-06-05
62+
63+
- Generated strings from `genString` now vary in length
64+
- Added additional `Char` generators
65+
66+
## [v3.1.0](https://github.com/purescript/purescript-strings/releases/tag/v3.1.0) - 2017-04-28
67+
68+
- Added some generator functions - introduced `Data.String.Gen` and `Data.Char.Gen`
69+
70+
## [v3.0.0](https://github.com/purescript/purescript-strings/releases/tag/v3.0.0) - 2017-03-26
71+
72+
- Updated for PureScript 0.11
73+
74+
## [v2.1.0](https://github.com/purescript/purescript-strings/releases/tag/v2.1.0) - 2016-12-25
75+
76+
Add `unsafeRegex` (@rightfold)
77+
78+
## [v2.0.2](https://github.com/purescript/purescript-strings/releases/tag/v2.0.2) - 2016-10-26
79+
80+
- Documentation fix for `split` #70 (@leighman)
81+
82+
## [v2.0.1](https://github.com/purescript/purescript-strings/releases/tag/v2.0.1) - 2016-10-08
83+
84+
- Improved `null` check implementation (@Risto-Stevcev)
85+
86+
## [v2.0.0](https://github.com/purescript/purescript-strings/releases/tag/v2.0.0) - 2016-10-08
87+
88+
- Updated dependencies
89+
- `Pattern` and `Replacement` newtypes are now used to distinguish between arguments when a function accepts multiple strings
90+
- `RegexFlags` have been reworked as a monoid (@Risto-Stevcev)
91+
92+
## [v1.1.0](https://github.com/purescript/purescript-strings/releases/tag/v1.1.0) - 2016-07-20
93+
94+
- Restored export of the `count` function.
95+
96+
## [v1.0.0](https://github.com/purescript/purescript-strings/releases/tag/v1.0.0) - 2016-06-01
97+
98+
This release is intended for the PureScript 0.9.1 compiler and newer.
99+
100+
**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.
101+
102+
## [v1.0.0-rc.2](https://github.com/purescript/purescript-strings/releases/tag/v1.0.0-rc.2) - 2016-05-20
103+
104+
- Fix unused import warning
105+
106+
## [v1.0.0-rc.1](https://github.com/purescript/purescript-strings/releases/tag/v1.0.0-rc.1) - 2016-03-24
107+
108+
- Release candidate for the psc 0.8+ core libraries
109+
110+
## [v0.7.1](https://github.com/purescript/purescript-strings/releases/tag/v0.7.1) - 2015-11-20
111+
112+
- Removed unused imports (@tfausak)
113+
114+
## [v0.7.0](https://github.com/purescript/purescript-strings/releases/tag/v0.7.0) - 2015-08-13
115+
116+
- Removed orphan (and incorrect) `Bounded Char` instance
117+
118+
## [v0.6.0](https://github.com/purescript/purescript-strings/releases/tag/v0.6.0) - 2015-08-02
119+
120+
- Added `toLower` and `toUpper` to `Data.Char`
121+
- `search` in `Data.String.Regex` now returns `Maybe` result rather than using -1 for failure
122+
- Added test suite
123+
124+
All updates by @LiamGoodacre
125+
126+
## [v0.5.5](https://github.com/purescript/purescript-strings/releases/tag/v0.5.5) - 2015-07-28
127+
128+
Add `stripSuffix`.
129+
130+
## [v0.5.4](https://github.com/purescript/purescript-strings/releases/tag/v0.5.4) - 2015-07-18
131+
132+
- Removed duplicate `Show` instance for `Char` (@anttih)
133+
134+
## [v0.5.3](https://github.com/purescript/purescript-strings/releases/tag/v0.5.3) - 2015-07-10
135+
136+
Add `stripPrefix` (@hdgarrood)
137+
138+
## [v0.5.2](https://github.com/purescript/purescript-strings/releases/tag/v0.5.2) - 2015-07-07
139+
140+
- Fixed `char` and `charCodeAt` in `Data.String.Unsafe` #36 (@stkb)
141+
142+
## [v0.5.1](https://github.com/purescript/purescript-strings/releases/tag/v0.5.1) - 2015-07-06
143+
144+
- Fixed missing `count` implementation (@qxjit)
145+
146+
## [v0.5.0](https://github.com/purescript/purescript-strings/releases/tag/v0.5.0) - 2015-06-30
147+
148+
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.
149+
150+
## [v0.5.0-rc.3](https://github.com/purescript/purescript-strings/releases/tag/v0.5.0-rc.3) - 2015-06-12
151+
152+
- Fixed various FFI exports (@sharkdp)
153+
154+
## [v0.5.0-rc.2](https://github.com/purescript/purescript-strings/releases/tag/v0.5.0-rc.2) - 2015-06-07
155+
156+
Fix `localeCompare`
157+
158+
## [v0.5.0-rc.1](https://github.com/purescript/purescript-strings/releases/tag/v0.5.0-rc.1) - 2015-06-07
159+
160+
Initial release candidate of the library intended for the 0.7 compiler.
161+
162+
## [v0.4.5](https://github.com/purescript/purescript-strings/releases/tag/v0.4.5) - 2015-03-23
163+
164+
- Added `char` to `Data.String.Unsafe` (@brainrape)
165+
- Functions in `Data.String.Unsafe` now throw errors immediately when given unacceptable inputs (@brainrape)
166+
167+
## [v0.4.4](https://github.com/purescript/purescript-strings/releases/tag/v0.4.4) - 2015-03-22
168+
169+
Updated docs
170+
171+
## [v0.4.3](https://github.com/purescript/purescript-strings/releases/tag/v0.4.3) - 2015-02-18
172+
173+
- Added `noFlags` record for default regex flags (@fresheyeball)
174+
175+
## [v0.4.2](https://github.com/purescript/purescript-strings/releases/tag/v0.4.2) - 2014-11-28
176+
177+
178+
179+
## [v0.4.1](https://github.com/purescript/purescript-strings/releases/tag/v0.4.1) - 2014-11-06
180+
181+
182+
183+
## [v0.4.0](https://github.com/purescript/purescript-strings/releases/tag/v0.4.0) - 2014-10-27
184+
185+
- Made `charCodeAt` safe, added unsafe versions of `charAt`, `charCodeAt` (@garyb)
186+
187+
## [v0.3.3](https://github.com/purescript/purescript-strings/releases/tag/v0.3.3) - 2014-10-24
188+
189+
- Added `split` to `Data.String.Regex` (@davidchambers)
190+
191+
## [v0.3.2](https://github.com/purescript/purescript-strings/releases/tag/v0.3.2) - 2014-10-16
192+
193+
194+
195+
## [v0.3.1](https://github.com/purescript/purescript-strings/releases/tag/v0.3.1) - 2014-10-15
196+
197+
198+
199+
## [v0.3.0](https://github.com/purescript/purescript-strings/releases/tag/v0.3.0) - 2014-10-14
200+
201+
- Introduced `Char` newtype and corresponding functions (@jdegoes)
202+
- Made `charAt` safe - breaking change (@jdegoes)
203+
204+
## [v0.2.1](https://github.com/purescript/purescript-strings/releases/tag/v0.2.1) - 2014-07-21
205+
206+
- Fix typo in FFI definition for `flags` (@garyb)
207+
208+
## [v0.2.0](https://github.com/purescript/purescript-strings/releases/tag/v0.2.0) - 2014-07-20
209+
210+
- `Show` instance for `Regex` (@michaelficarra)
211+
- `Regex` now has `RegexFlags` rather than a string for options (@michaelficarra)
212+
213+
## [v0.1.3](https://github.com/purescript/purescript-strings/releases/tag/v0.1.3) - 2014-05-04
214+
215+
Renamed `Data.String.Regex.replaceR` to `replace`, added `replace'` which uses a function to construct replacements for matches.
216+
217+
## [v0.1.2](https://github.com/purescript/purescript-strings/releases/tag/v0.1.2) - 2014-04-30
218+
219+
Added `indexOf'` and `lastIndexOf'` (paf31)
220+
221+
## [v0.1.1](https://github.com/purescript/purescript-strings/releases/tag/v0.1.1) - 2014-04-27
222+
223+
224+
225+
## [v0.1.0](https://github.com/purescript/purescript-strings/releases/tag/v0.1.0) - 2014-04-25
226+
227+
228+

0 commit comments

Comments
 (0)