[Maintenance] Update dependencies and enhance documentation #258
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This maintenance PR updates CI/CD dependencies (golangci-lint, gotestsum), removes the deprecated golangci-lint configuration file, fixes linter findings, significantly expands project documentation, and adds comprehensive LLM context documentation. The changes improve code quality, modernise the tooling stack, and enhance developer experience.
Changes
Infrastructure
.golangci.ymlconfiguration file (now using defaults)Documentation
llm.txt(727 lines), providing complete SDK context for AI-powered development tools, including:Testing
Linter:
Unit Tests:
Manual Testing:
Breaking Changes
✅ No breaking changes
All changes are internal:
Dependencies
golangci/golangci-lint-action: v6.5.2 → v9.0.0Checklist
go test ./...)gofmtRelated Issues
This is a routine maintenance update with no associated issues.
Notable Changes Details
Logic Fixes Explanation
The logical operator changes in tar and zip extract functions are technically equivalent but more explicit:
Before:
After:
By De Morgan's law:
!(A && B)≡(!A || !B). The new form is clearer about the intent: remove the existing file if EITHER it's not a directory OR the new entry is not a directory.Golangci-lint Version Jump
The jump from v1.x to v2.x of golangci-lint includes:
Removal of
.golangci.ymlindicates using sensible defaults rather than extensive customisation.