Skip to content

Commit b52f56c

Browse files
authored
chore: polish docs, CI comments, and changelog (#82)
Remove leftover Japanese text and clean up minor inconsistencies across docs and workflow files.
1 parent 9837113 commit b52f56c

7 files changed

Lines changed: 11 additions & 34 deletions

File tree

.github/workflows/ci-avx512.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name: AVX-512 CI
22

3-
# 手動実行のみ
3+
# Manual dispatch only
44
on:
55
workflow_dispatch:
66
inputs:

.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ jobs:
2727
- name: Setup Go
2828
uses: actions/setup-go@7a3fe6cf4cb3a834922a1244abfce67bcef6a0c5 # v6.2.0
2929
with:
30-
go-version-file: 'go.mod'
30+
go-version-file: 'go.mod'
3131

3232
- name: Run golangci-lint
3333
run: go run github.com/golangci/golangci-lint/v2/cmd/golangci-lint@v2.9.0 run

.github/workflows/release.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,4 +103,3 @@ jobs:
103103
args: release --clean
104104
env:
105105
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
106-

.goreleaser.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ release:
3737
# Auto-detect prerelease (e.g., v1.0.0-beta.1 is automatically prerelease)
3838
prerelease: auto
3939

40-
# Replace changelog to existing release notes
40+
# Replace existing release notes with the generated changelog
4141
mode: replace
4242

4343
# Release notes header

CHANGELOG.md

Lines changed: 2 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,6 @@
1111
- docs: update readme by @nnnkkk7 in https://github.com/nnnkkk7/go-simdcsv/pull/80
1212
- Release for v0.1.0 by @github-actions[bot] in https://github.com/nnnkkk7/go-simdcsv/pull/73
1313

14-
## [v0.1.0](https://github.com/nnnkkk7/go-simdcsv/compare/v0.0.14...v0.1.0) - 2026-02-14
15-
- refactor: enhance field parsing by adding quote detection and optimization flags by @nnnkkk7 in https://github.com/nnnkkk7/go-simdcsv/pull/72
16-
- test: add benchmark tests for writer by @nnnkkk7 in https://github.com/nnnkkk7/go-simdcsv/pull/74
17-
- refactor: optimize quote detection and writing by @nnnkkk7 in https://github.com/nnnkkk7/go-simdcsv/pull/75
18-
- refactor: adjust SIMD thresholds and optimize quote detection in Writer by @nnnkkk7 in https://github.com/nnnkkk7/go-simdcsv/pull/76
19-
- feat: use PCLMULQDQ by @nnnkkk7 in https://github.com/nnnkkk7/go-simdcsv/pull/77
20-
- deps: upgrade go version to go1.26 by @nnnkkk7 in https://github.com/nnnkkk7/go-simdcsv/pull/78
21-
- ci: add renovate by @nnnkkk7 in https://github.com/nnnkkk7/go-simdcsv/pull/79
22-
- docs: update readme by @nnnkkk7 in https://github.com/nnnkkk7/go-simdcsv/pull/80
23-
2414
## [v0.0.14](https://github.com/nnnkkk7/go-simdcsv/compare/v0.0.13...v0.0.14) - 2026-02-02
2515
- refactor: optimize chunk processing and introduce fast path for no-quote scenarios by @nnnkkk7 in https://github.com/nnnkkk7/go-simdcsv/pull/65
2616
- docs: update readme by @nnnkkk7 in https://github.com/nnnkkk7/go-simdcsv/pull/67
@@ -33,13 +23,7 @@
3323
- chore: update CPU feature detection to use archsimd package by @nnnkkk7 in https://github.com/nnnkkk7/go-simdcsv/pull/60
3424
- perf: optimize SIMD mask processing with prefix XOR by @nnnkkk7 in https://github.com/nnnkkk7/go-simdcsv/pull/62
3525
- refactor: enhance record parsing efficiency by introducing no-quote path and optimizing memory usage by @nnnkkk7 in https://github.com/nnnkkk7/go-simdcsv/pull/63
36-
- perf: improve memory allocation and parsing efficiency by @nnnkkk7 in https://github.com/nnnkkk7/go-simdcsv/pull/64
37-
38-
## [v0.0.12](https://github.com/nnnkkk7/go-simdcsv/compare/v0.0.11...v0.0.12) - 2026-01-27
39-
- docs: add performance comparison by @nnnkkk7 in https://github.com/nnnkkk7/go-simdcsv/pull/54
40-
- docs: update readme by @nnnkkk7 in https://github.com/nnnkkk7/go-simdcsv/pull/56
41-
- refactor: enhance error handling and improve code clarity by @nnnkkk7 in https://github.com/nnnkkk7/go-simdcsv/pull/57
42-
- chore: remove unused code by @nnnkkk7 in https://github.com/nnnkkk7/go-simdcsv/pull/58
26+
- perf: improve memory allocation and parsing efficiency by @nnnkkk7 in https://github.com/nnnkkk7/go-simdcsv/pull/64
4327

4428
## [v0.0.12](https://github.com/nnnkkk7/go-simdcsv/compare/v0.0.11...v0.0.12) - 2026-01-27
4529
- docs: add performance comparison by @nnnkkk7 in https://github.com/nnnkkk7/go-simdcsv/pull/54
@@ -55,7 +39,7 @@
5539
- refactor: optimize field content handling and enhance SIMD scanning performance by @nnnkkk7 in https://github.com/nnnkkk7/go-simdcsv/pull/47
5640
- ci: fix benchmart option by @nnnkkk7 in https://github.com/nnnkkk7/go-simdcsv/pull/48
5741
- refactor: enhance record building and parsing efficiency with CR handling by @nnnkkk7 in https://github.com/nnnkkk7/go-simdcsv/pull/49
58-
- refactor: update SIMD scanning to utilize archsimd.Int8x64 by @nnnkkk7 in https://github.com/nnnkkk7/go-simdcsv/pull/50
42+
- refactor: update SIMD scanning to utilize archsimd.Int8x64 by @nnnkkk7 in https://github.com/nnnkkk7/go-simdcsv/pull/50
5943
- refactor: optimize parseResult and scanResult pooling for improved me… by @nnnkkk7 in https://github.com/nnnkkk7/go-simdcsv/pull/51
6044
- refactor: adjust pooling capacities for parseResult and scanResult by @nnnkkk7 in https://github.com/nnnkkk7/go-simdcsv/pull/52
6145
- refactor: improve quoted field validation by leveraging parsed metadata by @nnnkkk7 in https://github.com/nnnkkk7/go-simdcsv/pull/53
@@ -88,12 +72,6 @@
8872
- docs: update readme by @nnnkkk7 in https://github.com/nnnkkk7/go-simdcsv/pull/21
8973
- docs: update readme by @nnnkkk7 in https://github.com/nnnkkk7/go-simdcsv/pull/22
9074

91-
## [v0.0.6](https://github.com/nnnkkk7/go-simdcsv/compare/v0.0.5...v0.0.6) - 2026-01-25
92-
- feat: implement SIMD-accelerated unescaping and quote handling by @nnnkkk7 in https://github.com/nnnkkk7/go-simdcsv/pull/18
93-
- docs: update readme by @nnnkkk7 in https://github.com/nnnkkk7/go-simdcsv/pull/20
94-
- docs: update readme by @nnnkkk7 in https://github.com/nnnkkk7/go-simdcsv/pull/21
95-
- docs: update readme by @nnnkkk7 in https://github.com/nnnkkk7/go-simdcsv/pull/22
96-
9775
## [v0.0.5](https://github.com/nnnkkk7/go-simdcsv/compare/v0.0.4...v0.0.5) - 2026-01-23
9876
- ci: fix goreleaser mode by @nnnkkk7 in https://github.com/nnnkkk7/go-simdcsv/pull/11
9977
- test: remove and integrate test by @nnnkkk7 in https://github.com/nnnkkk7/go-simdcsv/pull/13

Makefile

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,11 @@ docker-coverage:
2424
docker compose run --rm coverage
2525
go tool cover -html=coverage.out -o coverage.html
2626

27-
# Download benchmark datasets
27+
# Prepare directory for optional benchmark datasets (not bundled in the repo)
2828
download-testdata:
2929
@mkdir -p testdata/benchmark
30-
@echo "Downloading benchmark datasets..."
31-
# parking-citations, worldcitiespop, nyc-taxi-data
30+
@echo "Place benchmark CSV files under testdata/benchmark/."
31+
@echo "Suggested public datasets: parking-citations, worldcitiespop, nyc-taxi-data"
3232

3333
# Clean up
3434
clean:

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
[![Go Report Card](https://goreportcard.com/badge/github.com/nnnkkk7/go-simdcsv)](https://goreportcard.com/report/github.com/nnnkkk7/go-simdcsv)
55
[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
66

7-
SIMD-accelerated CSV parser for Go - Drop-in replacement for `encoding/csv` with AVX-512 optimization.
7+
SIMD-accelerated CSV parser for Go — drop-in replacement for `encoding/csv` with AVX-512 optimization.
88

99
> **Experimental**: Requires Go 1.26+ with `GOEXPERIMENT=simd`. The SIMD API is unstable and may change. Not recommended for production use.
1010
@@ -18,10 +18,10 @@ records, err := reader.ReadAll()
1818
if err != nil {
1919
log.Fatal(err)
2020
}
21-
// records: [[name age] [Alice 30] [Bob 25]]
21+
// records: [["name", "age"], ["Alice", "30"], ["Bob", "25"]]
2222
```
2323

24-
Same API as `encoding/csv` - just change the import.
24+
Same API as `encoding/csv` just change the import.
2525

2626
## Features
2727

0 commit comments

Comments
 (0)