Skip to content

Commit e1f8e42

Browse files
committed
Extending release notes in preparation to 1.0.0
1 parent d8abb49 commit e1f8e42

File tree

2 files changed

+27
-25
lines changed

2 files changed

+27
-25
lines changed

RELEASES.md

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,39 @@ LibPQ is a library for importing Power Query M language source files from local
44
and/or web storage. The project follows [semantic versioning](https://semver.org/)
55
specification.
66

7-
This document describes the changes between releases of LibPQ.
7+
This document describes the changes between releases of LibPQ. [Keeping a
8+
changelog](http://keepachangelog.com) is important!
89

910
<!--
1011
## Unreleased changes (currently in git `master`)
1112
-->
1213

1314
## Version 1.0.0 (2018-02-#N/A)
1415

15-
`Commit: master`
16+
#### Git commit: `#n/a`
1617

1718
This is the first release of LibPQ. The library and the loader are considered
1819
feature full and stable.
1920

20-
// TODO: complete this stub
21+
Most of the features are described in the [README](README.md) and in
22+
[documentation][docs]. Introductory overview is available at [author's
23+
blog][intro].
24+
25+
26+
#### New features
27+
- Import source code from plain text files located on disk or on the web
28+
- Unlimited number of import locations ordered by priority
29+
- [Unit testing][unittesting] framework
30+
- Show [docstrings] in Power Query user interface
31+
- A collection of general purpose [functions and queries][modules]
32+
- Compatibility with [@tycho01's library][tycho01]
33+
34+
[docs]: Docs/README.md
35+
[docstrings]: Docs/Docstrings.md
36+
[intro]: https://potyarkin.ml/posts/2018/expanding-power-query-standard-library-introducing-libpq/
37+
[modules]: Docs/Modules.md
38+
[tycho01]: https://github.com/tycho01/pquery
39+
[unittesting]: Docs/UnitTesting.md
40+
41+
42+
// TODO: update this stub with actual release date and commit hash

ROADMAP.md

Lines changed: 2 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ Current goals and values (in order of descending importance) are:
1414
use, and we should not interfere with the code they've built upon ours. This
1515
applies most strictly to the loader and the modules essential for internal
1616
use (e.g. UnitTest framework), other modules may see some breaking changes in
17-
future (that must always be documented in [release notes] and must be reflected
18-
in the release [version number][SemVer]).
17+
future (that must always be documented in [release notes](RELEASES.md) and
18+
must be reflected in the release [version number](https://semver.org/)).
1919
- **Improving import-time user experience**. LibPQ already offers local module
2020
listing, parses module docstrings for viewing in the UI and correctly relays
2121
errors in modules' code, but there must be other methods to improve module
@@ -34,23 +34,3 @@ Current goals and values (in order of descending importance) are:
3434
## Release 1.0 roadmap
3535
- Fix issue #7
3636
- Add release notes (markdown file, in root directory)
37-
- File name: RELEASES or CHANGELOG?
38-
- Keep release dates
39-
- Link git commit range
40-
- Newest releases on top of the file, [Unreleased] section for changes
41-
after the last release
42-
- Add a short description on top
43-
- Mention that the project follows semantic versioning https://semver.org/
44-
- Link to http://keepachangelog.com
45-
- Structured description
46-
- Release notes sections:
47-
- Added (features and improvements)
48-
- Changed
49-
- Deprecated
50-
- Removed
51-
- Fixed
52-
- Security
53-
54-
55-
[SemVer]: https://semver.org/
56-
[release notes]: RELEASES.md

0 commit comments

Comments
 (0)