docs: drop process artefacts, describe the project on its own terms - #5
Merged
Conversation
Reader-facing artefacts (README, contract) and in-code comments used
to expose the project's development history — task numbers, hotfix
versions, audit trail — alongside the actual content. A new reader
does not care which TODO.md row a behaviour came from; they want to
know what the project *is*, how to use it, and what its limits are.
This commit strips the process labels so the project reads as a normal
release:
- Delete CHANGELOG.md and TODO.md (both dev-process artefacts).
- Rename eight `test_task{N}_*.py` files to describe the area they
cover (e.g. `test_strategy_isolation.py`, `test_metrics_baseline.py`).
- Remove ~140 `Task X:` / `task X:` / `TODO.md` / `CHANGELOG.md`
references from src/ and tests/. Keep the design intent, drop the
development label.
- Rewrite the README's "项目状态" section as a "当前能力(按模块)"
+ "已知限制" pair: the project described by what it does and
what it does not, not by which task made it so.
- Compress mvp-contract.md §9 "修订记录" from a per-task
changelog into a single, deduplicated record of contract
changes; remove the "对应 TODO.md 任务 1" header.
No API or runtime behavior change. 668 unit tests + 4 real-data
integration tests stay green; `black --check` clean; `python -m
build` produces a v0.1.4 sdist + wheel.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Reader-facing artefacts (README, contract) and in-code comments used to expose the project's development history — task numbers, hotfix versions, audit trail — alongside the actual content. A new reader does not care which TODO.md row a behaviour came from; they want to know what the project is, how to use it, and what its limits are.
This commit strips the process labels so the project reads as a normal release:
test_task{N}_*.pyfiles to describe the area they cover (e.g.test_strategy_isolation.py,test_metrics_baseline.py).Task X:/task X:/TODO.md/CHANGELOG.mdreferences from src/ and tests/. Keep the design intent, drop the development label.No API or runtime behavior change. 668 unit tests + 4 real-data integration tests stay green;
black --checkclean;python -m buildproduces a v0.1.4 sdist + wheel.