Skip to content

Commit c208620

Browse files
committed
docs: add CHANGELOG and update README for v1.0.0 release
1 parent 7939375 commit c208620

2 files changed

Lines changed: 66 additions & 1 deletion

File tree

CHANGELOG.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [1.0.0] - 2026-03-29
9+
10+
### Added
11+
- **Core Library**: Complete 80-bit IEEE 754 extended double precision floating-point implementation
12+
- **Arithmetic Operations**: Full set of operations (add, subtract, multiply, divide, square root, natural logarithm, arctangent)
13+
- **Comparison Operations**: Complete comparison suite (equal, less than, greater than, etc.)
14+
- **Type Conversions**: Conversions to/from int32, int64, float32, float64
15+
- **Exception Handling**: IEEE 754 compliant exception handling with customizable callbacks
16+
- **Comprehensive Testing**: Unit tests with 48.2% code coverage
17+
- **Performance Benchmarks**: Extensive benchmark suite for performance validation
18+
- **Documentation**: Complete API reference, usage examples, and performance notes
19+
- **CI/CD Pipeline**: GitHub Actions workflows for testing, linting, and releases
20+
- **Development Tools**: Makefile with common development targets
21+
- **Security Analysis**: CodeQL integration for automated security scanning
22+
- **Dependency Management**: Automated dependency updates via Dependabot
23+
24+
### Features
25+
- **Precision**: 80-bit extended precision with 64-bit mantissa
26+
- **Compliance**: Full IEEE 754 standard implementation
27+
- **Performance**: Optimized bit-level operations
28+
- **Reliability**: Comprehensive error handling and edge case testing
29+
- **Maintainability**: Well-documented code with professional structure
30+
31+
### Technical Details
32+
- **Go Version**: Requires Go 1.22+
33+
- **Architecture**: Cross-platform (Linux, macOS, Windows)
34+
- **Testing**: Multi-version Go testing (1.21, 1.22, 1.23)
35+
- **Coverage**: 48.2% test coverage with HTML reports
36+
- **Linting**: Automated code quality checks (vet, golint, staticcheck)
37+
38+
### Infrastructure
39+
- **GitHub Actions**: Complete CI/CD pipeline
40+
- **Release Automation**: Automated GitHub releases on version tags
41+
- **Documentation**: Hosted on pkg.go.dev
42+
- **Coverage**: Integrated with Codecov
43+
- **Security**: Weekly CodeQL security scans
44+
45+
---
46+
47+
## [0.1] - 2026-03-XX
48+
49+
### Added
50+
- Initial implementation of 80-bit floating-point arithmetic
51+
- Basic operations and type definitions
52+
- Initial test suite
53+
- Basic documentation
54+
55+
---
56+
57+
[1.0.0]: https://github.com/jenska/float/releases/tag/v1.0.0
58+
[0.1]: https://github.com/jenska/float/releases/tag/0.1

readme.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,12 @@ This package is derived from the original SoftFloat package and was implemented
1313
## Installation
1414

1515
```bash
16-
go get github.com/jenska/float
16+
go get github.com/jenska/float@v1.0.0
1717
```
1818

19+
### Requirements
20+
- Go 1.22 or later
21+
1922
## Development
2023

2124
This project includes a Makefile for common development tasks:
@@ -439,6 +442,10 @@ The implementation is validated against:
439442

440443
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
441444

445+
## Changelog
446+
447+
See [CHANGELOG.md](CHANGELOG.md) for a complete list of changes and version history.
448+
442449
## Related Projects
443450

444451
- [SoftFloat](https://github.com/ucb-bar/berkeley-softfloat-3) - Reference soft float implementation

0 commit comments

Comments
 (0)