[docs] add CHANGELOG and CONTRIBUTING documentation - #11
Merged
Conversation
added 3 commits
May 16, 2026 22:46
- Add CHANGELOG.md with version history format - Add CONTRIBUTING.md with detailed contribution guidelines - Update README.md: - Algorithm completion: 28/37 → 33/37 (89.2%) - Test coverage: 77 unit test cases - Version history update - Add links to new documentation
### 文档整理 根目录保留必要文档: - README.md, CHANGELOG.md, CONTRIBUTING.md 移动到 docs/: - QUICK_BUILD.md → docs/build-guide.md - USER_GUIDE.md → docs/user-guide.md (更新内容) 删除重复/过时文档: - RELEASE_NOTES.md (已合并到 CHANGELOG.md) - RELEASE_README.md (与 README 重复) - docs/BUILD_GUIDE.md, docs/CHANGELOG.md - docs/HTML_INTEGRATION*.md - docs/PROTOCOL_REFACTOR*.md - docs/guides/*, docs/reports/* ### 更新的内容 docs/user-guide.md: - 对称密码: 7 → 10 - 公钥密码: 4 → 7 - 添加 SEAL, ZUC, Crypto-1, ECC, SM2, SM2 Sign docs/README.md: - 更新文档目录结构
### 归档策略 将过时文档移至 docs/archive/ 而非直接删除，保留项目历史 ### 新增归档目录 docs/archive/ ├── legacy/ # 过时的项目文档 (7个) ├── guides/ # 旧版开发指南 (6个) └── reports/ # 历史报告 (1个) ### 更新的文件 - README.md: 更新文档链接和目录结构 - docs/README.md: 更新文档目录说明 - docs/archive/README.md: 新增归档说明文档
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 freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
变更内容
新增文档
CHANGELOG.md
CONTRIBUTING.md
更新的文件
README.md
验证