idris-lang/Idris2
1
1
Fork 0
mirror of https://github.com/idris-lang/Idris2.git synced 2024-11-23 14:18:02 +03:00
Code Issues Projects Releases Wiki Activity

Add a new CHANGELOG_NEXT.md file and update documentation around CHANGELOG entries. (#3180)

Browse Source
This commit is contained in:
Mathew Polzin 2024-01-01 21:08:56 -06:00 committed by GitHub
parent ee18555869
commit aee1cb94ac
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 35 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.github/pull_request_template.md vendored
View File

@ -5,6 +5,6 @@
<!-- Please delete this section if it doesn't apply -->
- [ ] If this is a fix, user-facing change, a compiler change, or a new paper
implementation, I have updated `CHANGELOG.md` (and potentially also
implementation, I have updated [`CHANGELOG_NEXT.md`](https://github.com/idris-lang/Idris2/blob/main/CHANGELOG_NEXT.md) (and potentially also
`CONTRIBUTORS.md`).

28
CHANGELOG.md
View File

@ -1,30 +1,8 @@
This CHANGELOG describes the history of already-released versions. Please see [CHANGELOG_NEXT](./CHANGELOG_NEXT.md) for changes merged into the main branch but not yet released.
# Changelog
## [Next version]
### Language changes
### Compiler changes
### Library changes
#### Prelude
#### Base
* `Data.List.Lazy` was moved from `contrib` to `base`.
* Added an `Interpolation` implementation for primitive decimal numeric types and `Nat`.
* Added append `(++)` for `List` version of `All`.
#### Contrib
* `Data.List.Lazy` was moved from `contrib` to `base`.
* Existing `System.Console.GetOpt` was extended to support errors during options
parsing in a backward-compatible way.
## v0.7.0
### Language changes

29
CHANGELOG_NEXT.md Normal file
View File

@ -0,0 +1,29 @@
This CHANGELOG describes the merged but unreleased changes. Please see [CHANGELOG](./CHANGELOG.md) for changes to all previously released versions of Idris2. All new PRs should target this file (`CHANGELOG_NEXT`).
# Changelog
## [Next version]
### Language changes
### Compiler changes
### Library changes
#### Prelude
#### Base
* `Data.List.Lazy` was moved from `contrib` to `base`.
* Added an `Interpolation` implementation for primitive decimal numeric types and `Nat`.
* Added append `(++)` for `List` version of `All`.
#### Contrib
* `Data.List.Lazy` was moved from `contrib` to `base`.
* Existing `System.Console.GetOpt` was extended to support errors during options
parsing in a backward-compatible way.

2
CONTRIBUTING.md
View File

@ -53,7 +53,7 @@ we haven't been too prescriptive about this. If you're editing a source file,
try to be consistent with the existing style choices made by previous authors.
We may need to be more formal about this in future!
Please remember to update `CHANGELOG.md`, and if it's your first contribution
Please remember to update `CHANGELOG_NEXT.md`, and if it's your first contribution
you can add yourself to `CONTRIBUTORS`.
In all cases, a pull request must have a short description (one sentence is

2
Release/CHECKLIST
View File

@ -10,7 +10,7 @@
[x] Change version number in tests pkg010 and pkg017 (TODO: make this step unnecessary!)
N.B. There are 2 instances of these: tests/idris2/ and tests/idris2/pkg/
[x] Make sure INSTALL.md gives the correct minimum Idris version
[x] Update CHANGELOG.md to refer to the "Next version" changes as the new
[x] Move CHANGELOG_NEXT.md entries into CHANGELOG.md under a heading for the upcoming release version. Reset CHANGELOG_NEXT.md.
release version, leaving the next "Next version" blank.
[x] Update bootstrap chez and racket (built with new version)
[x] Compile Idris2 with the appropriate CG