docs: update documentation for Go 1.25.6 and code quality improvements

- Update Go version requirement from 1.25.5 to 1.25.6 in all docs (security fix)
- Add golangci-lint tooling information to CONTRIBUTING.md
- Document code quality improvements in STATUS.md including:
  - Security vulnerability resolution (GO-2026-4340)
  - Cyclomatic complexity reduction for 5 functions
  - Comprehensive error handling improvements
  - Complete style and formatting compliance
- Add code quality metrics section showing production readiness
- Update development workflow to include modern linting tools

Ensures documentation accurately reflects current security and quality status.
This commit is contained in:
Tobias Gesellchen
2026-02-01 22:17:46 +01:00
parent 2768838bad
commit 79140cfa78
5 changed files with 30 additions and 7 deletions
+9 -2
View File
@@ -24,7 +24,7 @@ This project adheres to our [Code of Conduct](CODE_OF_CONDUCT.md). By participat
### Prerequisites
- **Go 1.25.5 or later**: [Download Go](https://golang.org/dl/)
- **Go 1.25.6 or later**: [Download Go](https://golang.org/dl/)
- **Git**: For version control
- **Make**: For build automation (optional but recommended)
- **SoundTouch Device**: For testing (optional but valuable)
@@ -135,6 +135,12 @@ make build
# Run linting and formatting
make check
# Run golangci-lint specifically
golangci-lint run
# Auto-fix linting issues where possible
golangci-lint run --fix
# Install CLI locally
go install ./cmd/soundtouch-cli
@@ -198,7 +204,8 @@ SOUNDTOUCH_DEBUG=true
Follow standard Go conventions:
- **gofmt** for formatting
- **golint** and **go vet** for code quality
- **golangci-lint** for comprehensive code quality checks
- **go vet** for static analysis
- **Effective Go** principles
- **Standard library patterns** where applicable
+1 -1
View File
@@ -327,7 +327,7 @@ This library supports all Bose SoundTouch-compatible devices, including:
## Development
### Prerequisites
- Go 1.25.5 or later
- Go 1.25.6 or later
- Optional: SoundTouch device for testing
### Building from Source
+1 -1
View File
@@ -6,7 +6,7 @@ This guide will get you up and running with the SoundTouch Go client in under 10
## 📋 **Prerequisites**
- **Go 1.25.5 or later** installed on your system
- **Go 1.25.6 or later** installed on your system
- **Bose SoundTouch device** on your network (SoundTouch 10, 20, 30, etc.)
- **Same network** - Your computer and SoundTouch device must be on the same network
+1 -1
View File
@@ -245,7 +245,7 @@ BenchmarkGetServiceAvailability-8 1000 1.2ms/op
- **Standard library only** - No external dependencies beyond existing project requirements
- **Backward compatible** - Works with existing client configurations
- **Go version support** - Compatible with Go 1.25.5+
- **Go version support** - Compatible with Go 1.25.6+
## Documentation
+18 -2
View File
@@ -210,7 +210,7 @@ This project implements a comprehensive Go client library and CLI tool for Bose
- Development convenience commands ✅
### Dependencies
- Modern Go modules (Go 1.25.5+) ✅
- Modern Go modules (Go 1.25.6+) ✅
- Minimal external dependencies ✅
- Standard library focus ✅
@@ -263,6 +263,12 @@ This project implements a comprehensive Go client library and CLI tool for Bose
- [ ] Web application interface
### Recent Major Updates
- **2026-02-01**: Code quality improvements - Resolved all golangci-lint issues (59→0)
- ✅ Security: Updated Go 1.25.5→1.25.6 to fix TLS vulnerability GO-2026-4340
- ✅ Complexity: Refactored 5 high-complexity functions for better maintainability
- ✅ Error Handling: Fixed unchecked error returns and improved error messages
- ✅ Style: Applied comprehensive code formatting and style improvements
- ✅ Testing: Enhanced test helper functions and removed unused code
- **2026-01-09**: Preset management (read-only) with comprehensive analysis methods
- **2026-01-09**: Balance control implementation completing audio management trilogy
- **2026-01-09**: Bass control implementation with range validation and convenience methods
@@ -288,9 +294,19 @@ This project implements a comprehensive Go client library and CLI tool for Bose
### Development Notes
- All major architectural decisions documented
- Code follows Go best practices
- Code follows Go best practices with comprehensive linting enforcement
- Tests provide excellent regression protection
- Real device testing ensures API compatibility
- Zero security vulnerabilities (verified with govulncheck)
- Production-ready code quality with automated formatting and style checks
### Code Quality Metrics
- ✅ **Security**: Zero vulnerabilities, modern Go version (1.25.6+)
- ✅ **Maintainability**: All functions under cyclomatic complexity threshold (<15)
- ✅ **Error Handling**: Comprehensive error checking and proper error wrapping
- ✅ **Testing**: Test helpers with proper t.Helper() calls, no unused code
- ✅ **Style**: Consistent formatting with golangci-lint enforcement
- ✅ **Documentation**: Complete API documentation with proper comments
---