-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #3 from Naapperas/docs/changelog
Added changelog
- Loading branch information
Showing
1 changed file
with
34 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
# Changelog | ||
|
||
All notable changes to this project will be 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). | ||
|
||
> This changelog was generated some commits after the [v1.0.0 tag](https://github.com/Naapperas/zon/releases/tag/v1.0.0), so the changelog will have some inconsistencies until the next release. | ||
## [Unreleased] | ||
|
||
### Added | ||
- `zon` now has a changelog. | ||
- Added `zon.traits` module for common functionality that is specific to no validator. | ||
- Added the `zon.traits.collection` file which contains the `ZonCollection` class: this is the base class for all collection types. | ||
- Added testing for `ZonCollection` and added more tests for `ZonString`. | ||
- Scripts that automate the building and publishing of the package to PyPI. | ||
|
||
### Changed | ||
- `ZonString` now inherits from `ZonCollection` instead of `Zon`. | ||
- `ZonList` now inherits from `ZonCollection` instead of `Zon`. | ||
- Updated `README.md` to include more information and examples of code usage. | ||
|
||
### Removed | ||
- Removed the `len` function from `ZonString` and `ZonList` as it was not being used and did too much. | ||
|
||
## [1.0.0] - 2023-11-26 | ||
|
||
### Added | ||
- Added base source code files for the project. | ||
- Base `README.md` file. | ||
|
||
[unreleased]: https://github.com/Naapperas/zon/compare/v1.0.0...HEAD | ||
[1.0.0]: https://github.com/Naapperas/zon/releases/tag/v1.0.0 |