Skip to content

Commit 1703037

Browse files
committed
v0.0.0-alpha.1
# v0.0.0-alpha.1 ### Changes - Updated the `gitnore`, `tsconfig` and `npm` package to appropriately handle the new `lib/` folder - Added dependencies for, and tweaked, linting - Added `.prettierrc` for consistent formatting (and applied it) - Added some package scripts for linting, formatting, building, etc - Removed `.npmignore` in favour of `"files"` in the `package.json`
1 parent 15a4cbc commit 1703037

File tree

3 files changed

+1358
-24
lines changed

3 files changed

+1358
-24
lines changed

CHANGELOG.md

+43-3
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,52 @@
1+
<!--
2+
Guiding Principles
3+
- Changelogs are for humans, not machines.
4+
- There should be an entry for every single version.
5+
- The same types of changes should be grouped.
6+
- Versions and sections should be linkable.
7+
- The latest version comes first.
8+
- The release date of each version is displayed.
9+
- Mention whether you follow Semantic Versioning.
10+
11+
Types of changes
12+
- Added for new features.
13+
- Changed for changes in existing functionality.
14+
- Deprecated for soon-to-be removed features.
15+
- Removed for now removed features.
16+
- Fixed for any bug fixes.
17+
- Security in case of vulnerabilities.
18+
- Breaking changes for break in new revision
19+
- Other for notable changes that do not
20+
-->
21+
122
# Changelog
223

324
All notable changes to this project will be documented in this file.
425

526
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
627
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
728

8-
## [UNRELEASED]
29+
> **⚠ Alphas may contain breaking changes between releases.**
30+
>
31+
> When the release is NOT a major release, the breaking changes will only be relative to the prior `alpha` release
32+
>
33+
> As this package is not released (kind of), this change log will be cleared on the official release of `v1`
34+
35+
## v0.0.0-alpha.1
36+
37+
### Changes
38+
39+
- Updated the `gitnore`, `tsconfig` and `npm` package to appropriately handle the new `lib/` folder
40+
- Added dependencies for, and tweaked, linting
41+
- Added `.prettierrc` for consistent formatting (and applied it)
42+
- Added some package scripts for linting, formatting, building, etc
43+
- Removed `.npmignore` in favour of `"files"` in the `package.json`
44+
45+
<!--
46+
## [1.0.0] - 2021-06-##
947
10-
**Initial release**
48+
**This was the first release**
1149
12-
[unreleased]: https://github.com/olivierlacan/keep-a-changelog/compare/HEAD...development
50+
[unreleased]: https://github.com/TopMarksDevelopment/JavaScript.HoverBox/compare/v1.0.0...development
51+
[1.0.0]: https://github.com/TopMarksDevelopment/JavaScript.HoverBox/release/tag/v1.0.0
52+
-->

0 commit comments

Comments
 (0)