Skip to content

Commit 6c1ffa9

Browse files
refactor: slim project to lean C++17 lab (Occam's razor)
Remove over-engineering for a hobby/learning project: - Delete VitePress docs site (docs/, root package.json, 9632 lines), bilingual README (keep Chinese-only), and ADRs. - Delete governance docs (CODE_OF_CONDUCT, SECURITY, CONTEXT, CONTRIBUTING) and .devcontainer/. - Remove Streaming state-machine layer (encoder.hpp with State/Encoder/Decoder abstract classes, BufferEncoder/BufferDecoder wrappers). encode_buffer/decode_buffer now take a BufferTransform function pointer directly — algorithms never used the streaming interface. - Prune StatusCode enum to used values (OK/ERR_CORRUPT/ERR_SIZE_LIMIT); drop unused INITIAL_DECODE_OVERHEAD constant. - Merge CI into single ci.yml (remove ci-docs, codeql, docs-pages). - Simplify issue/PR templates (drop Go/Rust/OpenSpec/streaming refs). Binary format contract preserved (magic bytes, frequency table LE layout, RLE pair layout, 4 GiB/1 GiB limits). 4 algorithms unchanged (720 lines). shared layer: 1183 -> 735 lines. Net: -16627 lines. Verified: make test (36 CLI smoke + unit tests), make lint, 4-algo round-trip. Generated with [Devin](https://devin.ai) Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
1 parent f51d186 commit 6c1ffa9

98 files changed

Lines changed: 77 additions & 16627 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.devcontainer/Dockerfile

Lines changed: 0 additions & 17 deletions
This file was deleted.

.devcontainer/devcontainer.json

Lines changed: 0 additions & 15 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,13 @@ Describe the failure in one or two sentences.
1313
## Scope
1414

1515
- Algorithm: Huffman / Arithmetic / Range Coder / RLE / Shared
16-
- Language: C++17 / Python scripts / Docs
17-
- Surface: CLI / library API / streaming API / conformance / docs / CI
16+
- Surface: CLI / library API / conformance / CI
1817

1918
## Reproduction
2019

2120
```bash
2221
# Paste the smallest command sequence that reproduces the issue.
23-
make test-conformance
22+
make test
2423
```
2524

2625
If the issue depends on an input file, include:

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 0 additions & 41 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: Feature request
3-
about: Propose a focused CompressKit algorithm, tooling, docs, or verification change
3+
about: Propose a focused CompressKit algorithm, tooling, or verification change
44
title: "[FEATURE] "
55
labels: enhancement
66
assignees: ""
@@ -18,8 +18,7 @@ Describe the smallest useful change.
1818
## Affected areas
1919

2020
- Algorithm: Huffman / Arithmetic / Range Coder / RLE / Shared / N/A
21-
- Language: C++17 / Python scripts / Docs / CI
22-
- Contract impact: CLI / binary format / streaming API / conformance / none
21+
- Contract impact: CLI / binary format / conformance / none
2322

2423
## Verification plan
2524

.github/ISSUE_TEMPLATE/feature_request.yml

Lines changed: 0 additions & 33 deletions
This file was deleted.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,30 +5,25 @@ Explain what changed and why.
55
## Scope
66

77
- [ ] Algorithm implementation
8-
- [ ] Shared streaming/buffer layer
9-
- [ ] Cross-language conformance
10-
- [ ] Documentation / Git Pages
8+
- [ ] Shared buffer layer
119
- [ ] CI / repository tooling
12-
- [ ] OpenSpec
1310

14-
Affected algorithms/languages:
11+
Affected algorithms:
1512

1613
- Algorithm: Huffman / Arithmetic / Range Coder / RLE / Shared / N/A
17-
- Language: C++17 / Go / Rust / Python scripts / Docs / CI
1814

1915
## Compatibility
2016

2117
- [ ] No binary format change
22-
- [ ] Binary format change, OpenSpec updated
23-
- [ ] Cross-language behavior changed, `make test-conformance` updated
18+
- [ ] Binary format change (requires design review)
2419

2520
## Verification
2621

2722
Paste the commands run locally:
2823

2924
```bash
3025
make test
31-
npm run docs:build
26+
make lint
3227
```
3328

3429
## Review focus
@@ -38,4 +33,3 @@ Call out anything reviewers should inspect closely, especially:
3833
- encoder/decoder pair compatibility
3934
- Range Coder large-file behavior
4035
- generated artifacts or ignored files
41-
- OpenSpec requirement alignment

.github/workflows/ci-docs.yml

Lines changed: 0 additions & 46 deletions
This file was deleted.

.github/workflows/codeql.yml

Lines changed: 0 additions & 48 deletions
This file was deleted.

.github/workflows/docs-pages.yml

Lines changed: 0 additions & 74 deletions
This file was deleted.

0 commit comments

Comments
 (0)